Interface IDocumentTemplateDefinition
-
- All Superinterfaces:
ICICSDefinition
,ICICSObject
,IDefinition
,com.ibm.cics.model.meta.ITypedObject
public interface IDocumentTemplateDefinition extends ICICSDefinition
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
IDocumentTemplateDefinition.ChangeAgentValue
Enumeration type for field CHANGEAGENTstatic class
IDocumentTemplateDefinition.DoctypeValue
Enumeration type for field DOCTYPE
-
Field Summary
-
Fields inherited from interface com.ibm.cics.model.ICICSDefinition
COPYRIGHT
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ICICSEnums.YesNoValue
getAppendcrlf()
Getter for field APPENDCRLFIDocumentTemplateDefinition.ChangeAgentValue
getChangeAgent()
Getter for field CHANGEAGENTICICSDefinitionReference<IDocumentTemplateDefinition>
getCICSObjectReference()
java.lang.String
getDdname()
Getter for field DDNAMEIDocumentTemplateDefinition.DoctypeValue
getDoctype()
Getter for field DOCTYPEjava.lang.String
getExitProgram()
Getter for field EXITPGMjava.lang.String
getFile()
Getter for field FILEjava.lang.String
getHfsfile()
Getter for field HFSFILEjava.lang.String
getMembername()
Getter for field MEMBERNAMEICICSType<IDocumentTemplateDefinition>
getObjectType()
java.lang.String
getProgram()
Getter for field PROGRAMjava.lang.String
getTdqueue()
Getter for field TDQUEUEjava.lang.String
getTemplateName()
Getter for field TEMPLATENAMEjava.lang.String
getTsqueue()
Getter for field TSQUEUEjava.lang.String
getUserdata1()
Getter for field USERDATA1java.lang.String
getUserdata2()
Getter for field USERDATA2java.lang.String
getUserdata3()
Getter for field USERDATA3-
Methods inherited from interface com.ibm.cics.model.ICICSDefinition
getChangeAgentRelease, getChangeTime, getChangeUserID, getCICSContainer, getCreateTime, getCSDGroup, getDescription, getVersion
-
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType, getName
-
-
-
-
Method Detail
-
getObjectType
ICICSType<IDocumentTemplateDefinition> getObjectType()
- Specified by:
getObjectType
in interfaceICICSDefinition
- Specified by:
getObjectType
in interfaceICICSObject
- Specified by:
getObjectType
in interfaceIDefinition
- Specified by:
getObjectType
in interfacecom.ibm.cics.model.meta.ITypedObject
-
getChangeAgent
IDocumentTemplateDefinition.ChangeAgentValue getChangeAgent()
Getter for field CHANGEAGENTLast modification agent
The change agent identifier that made the last modification.
- CSDAPI - The resource was last changed by a CEDA transaction, by the programmable interface to DFHEDAP or by an EXEC CICS CSD command.
- CSDBATCH - The resource was last changed by a DFHCSDUP job.
- DREPAPI - Resource was last changed by a CICSPlex SM API command.
- N_A - Resource was created or last updated prior to CICS TS Version 4 Release 1 and support for resource signatures.
-
getExitProgram
java.lang.String getExitProgram()
Getter for field EXITPGMExit 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 FILEFile 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 DDNAMEDDname 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 MEMBERNAMEMember 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 PROGRAMProgram 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 TSQUEUETemporary 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 TDQUEUETransient 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 USERDATA1User 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 USERDATA2User 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 USERDATA3User 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 TEMPLATENAMEDocument 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 APPENDCRLFCarriage 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:
- YES - Carriage return/linefeed pairs should be appended, and trailing blanks should be removed.
- NO - Carriage return/linefeed pairs should not be appended, and trailing blanks should not be removed.
-
getDoctype
IDocumentTemplateDefinition.DoctypeValue getDoctype()
Getter for field DOCTYPEDocument content type
Specifies the format of the contents of the template:
- BINARY - When the template is loaded from the template library, no parsing of the template's contents is done.
- EBCDIC - When the template is loaded from the template library, the contents are parsed as EBCDIC text.
-
getHfsfile
java.lang.String getHfsfile()
Getter for field HFSFILEzSeries 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.
-
getCICSObjectReference
ICICSDefinitionReference<IDocumentTemplateDefinition> getCICSObjectReference()
- Specified by:
getCICSObjectReference
in interfaceICICSDefinition
- Specified by:
getCICSObjectReference
in interfaceICICSObject
- Specified by:
getCICSObjectReference
in interfaceIDefinition
-
-