|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IDocumentTemplate
generated from CICS resourcetable DOCTEMP
Nested Class Summary | |
---|---|
static class |
IDocumentTemplate.AppendCRLFValue
Enumeration type for field APPENDCRLF |
static class |
IDocumentTemplate.ChangeAgentValue
Enumeration type for field CHANGEAGENT |
static class |
IDocumentTemplate.ContentTypeValue
Enumeration type for field DOCTYPE |
static class |
IDocumentTemplate.InstallAgentValue
Enumeration type for field INSTALLAGENT |
static class |
IDocumentTemplate.NewcopyStatusValue
Enumeration type for field COPY |
static class |
IDocumentTemplate.TemplateTypeValue
Enumeration type for field TEMPLATETYPE |
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT
|
Method Summary | |
---|---|
IDocumentTemplate.AppendCRLFValue |
getAppendCRLF()
Getter for field APPENDCRLF |
java.lang.Long |
getBasdefinever()
Getter for field BASDEFINEVER |
java.lang.Long |
getCacheDeleteCount()
Getter for field CACHEDELD |
java.lang.Long |
getCacheSize()
Getter for field CACHESIZE |
java.lang.Long |
getCacheUseCount()
Getter for field CACHEUSED |
IDocumentTemplate.ChangeAgentValue |
getChangeAgent()
Getter for field CHANGEAGENT |
java.lang.String |
getChangeAgentRelease()
Getter for field CHANGEAGREL |
java.util.Date |
getChangeTime()
Getter for field CHANGETIME |
java.lang.String |
getChangeUserID()
Getter for field CHANGEUSRID |
IDocumentTemplate.ContentTypeValue |
getContentType()
Getter for field DOCTYPE |
java.lang.String |
getDDName()
Getter for field DDNAME |
java.lang.String |
getDefineSource()
Getter for field DEFINESOURCE |
java.util.Date |
getDefineTime()
Getter for field DEFINETIME |
java.lang.String |
getDSName()
Getter for field DSNAME |
java.lang.String |
getExitProgram()
Getter for field EXITPGM |
java.lang.String |
getFile()
Getter for field FILE |
java.lang.String |
getHFSFile()
Getter for field HFSFILE |
IDocumentTemplate.InstallAgentValue |
getInstallAgent()
Getter for field INSTALLAGENT |
java.util.Date |
getInstallTime()
Getter for field INSTALLTIME |
java.lang.String |
getInstallUserID()
Getter for field INSTALLUSRID |
java.lang.String |
getMember()
Getter for field MEMBER |
java.lang.String |
getName()
Getter for field NAME |
java.lang.Long |
getNewcopyCount()
Getter for field NEWCOPYCNT |
IDocumentTemplate.NewcopyStatusValue |
getNewcopyStatus()
Getter for field COPY |
java.lang.String |
getProgram()
Getter for field PROGRAM |
java.lang.Long |
getReadCount()
Getter for field READCOUNT |
java.lang.String |
getTDQueue()
Getter for field TDQUEUE |
java.lang.String |
getTemplateName()
Getter for field TEMPLATENAME |
IDocumentTemplate.TemplateTypeValue |
getTemplateType()
Getter for field TEMPLATETYPE |
java.lang.String |
getTSQueue()
Getter for field TSQUEUE |
java.lang.Long |
getUseCount()
Getter for field USECOUNT |
Methods inherited from interface com.ibm.cics.model.ICICSResource |
---|
getCICSRelease, getRegionName |
Methods inherited from interface com.ibm.cics.model.ICICSObject |
---|
getCICSType, getObjectType |
Field Detail |
---|
static final java.lang.String COPYRIGHT
Method Detail |
---|
java.lang.String getName()
Document template name
The name of the document template
getName
in interface ICICSObject
java.lang.String getExitProgram()
Exit program name
Name of the exit program for the document template.
java.lang.String getFile()
File name
The name of the file for the document template.
java.lang.String getDDName()
DD name of the partitioned data set
The DDname of the partitoned data set for the document template.
java.lang.String getMember()
Name of the member in partitioned data set
The member of the partitoned dataset for the document template.
java.lang.String getProgram()
Program name
The program for the document template.
java.lang.String getTSQueue()
Temporary storage queue name
The identifier of the temporary storage queue for the document template.
java.lang.String getTDQueue()
Transient data queue name
The identifier of the transient data queue for the document template.
IDocumentTemplate.TemplateTypeValue getTemplateType()
Document template type
The type of document template. Available types of document template are:
java.lang.String getTemplateName()
Extended document template name
The full name of the document template.
java.lang.String getDSName()
Data set name of partitioned data set
The data set name (dsname) for the document template.
IDocumentTemplate.ContentTypeValue getContentType()
Document content type
The data type of the contents of the document. Values are BINARY or EBCDIC.
IDocumentTemplate.AppendCRLFValue getAppendCRLF()
Carriage return line feed (CRLF) append option
The option to append carriage return, line feed (CRLF) to document template records when they are read. Values are APPEND, NOAPPEND.
java.lang.String getHFSFile()
Hierarchical File System template file
The name of the hierarchical file system (HFS) template file
IDocumentTemplate.NewcopyStatusValue getNewcopyStatus()
New copy status of the DOCTEMPLATE
The COPY status of the doctemplate, which determines whether or not a new copy of the doctemplate is required.
java.lang.Long getCacheSize()
Size in bytes of DOCTEMPLATE
The amount of storage required for a cached copy of the document template. Before the first use of the template, this field is zero. This field is always zero for templates in a CICS program, which are never cached, and for templates in an exit program if they are not specified for caching.
java.lang.Long getUseCount()
Total number of times DOCTEMPLATE has been used
The total number of times the document template was referenced for any reason.
java.lang.Long getNewcopyCount()
Total number of NEWCOPY requests issued
The number of times the SET DOCTEMPLATE NEWCOPY command was issued for this document template.
java.lang.Long getReadCount()
Total number of DOCTEMPLATE reads
The number of times the document template was read from the source.
java.lang.Long getCacheUseCount()
Total number of DOCTEMPLATE accesses from Cache
The number of times an application used the cached copy of the document template.
java.lang.Long getCacheDeleteCount()
Total number of DOCTEMPLATE deletes from Cache
The number of times the cached copy of the document template was deleted because of a short on storage condition.
java.lang.String getChangeUserID()
Last modification user ID
The user ID that made the last modification to the resource definition.
IDocumentTemplate.ChangeAgentValue getChangeAgent()
Last modification agent
The change agent identifier that made the last modification.
java.lang.String getChangeAgentRelease()
Last modification agent release
The CICS release level of the agent that made the last modification to the resource definition.
java.util.Date getChangeTime()
Last modification time
The local date and time when the definition was last changed.
java.lang.String getDefineSource()
Source of the resource definition
The source of the definition, depending on which agent made the last change.
java.util.Date getDefineTime()
Creation time
The local date and time when the resource definition record was created on DFHCSD or EYUDREP.
java.lang.String getInstallUserID()
Installation user ID
The user ID that installed the resource definition.
java.util.Date getInstallTime()
Installation time
The local date and time when the definition was installed.
IDocumentTemplate.InstallAgentValue getInstallAgent()
Installation agent
The install agent identifier that made the installation.
java.lang.Long getBasdefinever()
BAS resource definition version
The BAS version number of this definition.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |