com.ibm.cics.model
Interface IDocumentTemplateDefinition

All Superinterfaces:
ICICSDefinition, ICICSObject, IDefinition, com.ibm.cics.model.meta.ITypedObject

public interface IDocumentTemplateDefinition
extends ICICSDefinition

generated from CICS resourcetable DOCDEF


Nested Class Summary
static class IDocumentTemplateDefinition.DoctypeValue
          Enumeration type for field DOCTYPE
 
Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 ICICSEnums.YesNoValue getAppendcrlf()
          Getter for field APPENDCRLF
 java.lang.String getDdname()
          Getter for field DDNAME
 IDocumentTemplateDefinition.DoctypeValue getDoctype()
          Getter for field DOCTYPE
 java.lang.String getExitProgram()
          Getter for field EXITPGM
 java.lang.String getFile()
          Getter for field FILE
 java.lang.String getHfsfile()
          Getter for field HFSFILE
 java.lang.String getMembername()
          Getter for field MEMBERNAME
 java.lang.String getProgram()
          Getter for field PROGRAM
 java.lang.String getTdqueue()
          Getter for field TDQUEUE
 java.lang.String getTemplateName()
          Getter for field TEMPLATENAME
 java.lang.String getTsqueue()
          Getter for field TSQUEUE
 java.lang.String getUserdata1()
          Getter for field USERDATA1
 java.lang.String getUserdata2()
          Getter for field USERDATA2
 java.lang.String getUserdata3()
          Getter for field USERDATA3
 
Methods inherited from interface com.ibm.cics.model.ICICSDefinition
getChangeAgent, getChangeAgentRelease, getChangeTime, getChangeUserID, getCreateTime, getCSDGroup, getDescription, getVersion
 
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType, getName, getObjectType
 

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT
See Also:
Constant Field Values
Method Detail

getExitProgram

java.lang.String getExitProgram()
Getter for field EXITPGM

Exit program name

Name of the exit program for the document template. The name can be up to eight characters in length. If you specify this attribute, you cannot specify DDNAME, FILE, MEMBERNAME, PROGRAM, TDQUEUE, TSQUEUE or HFSFILE.


getFile

java.lang.String getFile()
Getter for field FILE

File name

The name of the file when the template resides in a CICS file. The name can be eight characters in length. If you specify this attribute, you cannot specify DDNAME, EXITPGM, MEMBERNAME, PROGRAM, TDQUEUE, TSQUEUE or HFSFILE.


getDdname

java.lang.String getDdname()
Getter for field DDNAME

DDname of partitioned data set

The DDname of the PDS. The name can be up to eight characters in length. If you specify a value for the MEMBERNAME attribute, but do not specify a value for DDNAME, the default value of DFHHTML is taken. If you specify this attribute, you cannot specify EXITPGM, FILE, PROGRAM, TDQUEUE, TSQUEUE or HFSFILE.


getMembername

java.lang.String getMembername()
Getter for field MEMBERNAME

Member of partitioned data set

When the template resides in an MVS partitioned data set (PDS), specifies the name of the member containing the template. The name can be up to eight characters in length. If you specify this attribute, you cannot specify EXITPGM, FILE, PROGRAM, TDQUEUE, TSQUEUE or HFSFILE.


getProgram

java.lang.String getProgram()
Getter for field PROGRAM

Program name

When the template resides in a CICS program, specifies the name of the program. The name can be up to eight characters in length. If you specify this attribute, you cannot specify DDNAME, EXITPGM, FILE, MEMBERNAME, TDQUEUE, TSQUEUE or HFSFILE.


getTsqueue

java.lang.String getTsqueue()
Getter for field TSQUEUE

Temporary storage queue name

When the template resides in a temporary storage queue, specifies the name of the queue. The name can be up to 16 characters in length. If you specify this attribute, you cannot specify DDNAME, EXITPGM, FILE, MEMBERNAME, PROGRAM, TDQUEUE or HFSFILE.


getTdqueue

java.lang.String getTdqueue()
Getter for field TDQUEUE

Transient data queue name

When the template resides in a transient data queue, specifies the name of the queue. The name can be up to four characters in length. If you specify this attribute, you cannot specify DDNAME, EXITPGM, FILE, MEMBERNAME, PROGRAM, TSQUEUE or HFSFILE.


getUserdata1

java.lang.String getUserdata1()
Getter for field USERDATA1

User data area 1

Optional string of up to 8 characters that allows you to provide additional site-specific data related to the BAS resource definition. This field is ignored for CICS CSD resource definitions.


getUserdata2

java.lang.String getUserdata2()
Getter for field USERDATA2

User data area 2

Optional string of up to 8 characters that allows you to provide additional site-specific data related to the BAS resource definition. This field is ignored for CICS CSD resource definitions.


getUserdata3

java.lang.String getUserdata3()
Getter for field USERDATA3

User data area 3

Optional string of up to 8 characters that allows you to provide additional site-specific data related to the BAS resource definition. This field is ignored for CICS CSD resource definitions.


getTemplateName

java.lang.String getTemplateName()
Getter for field TEMPLATENAME

Document template name

The name by which the template is known to application programs that use it. The name can be up to 48 characters in length. If no value is specified, the default is the 1- to 8-character name for the document template definition.


getAppendcrlf

ICICSEnums.YesNoValue getAppendcrlf()
Getter for field APPENDCRLF

Carriage return line feed (CRLF) append option

Specifies whether CICS is to delete trailing blanks from and append carriage-return line-feed to each logical record of the template as it is read from the PDS, FILE, TDQUEUE, or TS QUEUE:


getDoctype

IDocumentTemplateDefinition.DoctypeValue getDoctype()
Getter for field DOCTYPE

Document content type

Specifies the format of the contents of the template:


getHfsfile

java.lang.String getHfsfile()
Getter for field HFSFILE

Hierarchical File System template file

When the template resides in a z/OS UNIX System Services file, this specifies the fully qualified (absolute) or relative name of the z/OS UNIX file. The name can be specified as an absolute name including all directories and beginning with a slash, for example, /u/facts/images/bluefish.jpg. Alternatively, it can be specified as a name relative to the HOME directory of the CICS region user ID, for example, facts/images/bluefish.jpg. Up to 255 characters can be used. If you specify this attribute, you cannot specify DDNAME, EXITPGM, FILE, MEMBERNAME, PROGRAM, TDQUEUE or TSQUEUE.



Copyright © 2008-2012 IBM Corp. All Rights Reserved.