Interface IDocumentTemplate

    • Method Detail

      • getName

        java.lang.String getName()
        Getter for field NAME

        Document template name

        The name of the document template

        Specified by:
        getName in interface ICICSObject
      • getExitProgram

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

        Exit program name

        Name of the exit program for the document template.

      • getFile

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

        File name

        The name of the file for the document template.

      • getDDName

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

        DD name of the partitioned data set

        The DDname of the partitoned data set for the document template.

      • getMember

        java.lang.String getMember()
        Getter for field MEMBER

        Name of the member in partitioned data set

        The member of the partitoned dataset for the document template.

      • getProgram

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

        Program name

        The program for the document template.

      • getTSQueue

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

        Temporary storage queue name

        The identifier of the temporary storage queue for the document template.

      • getTDQueue

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

        Transient data queue name

        The identifier of the transient data queue for the document template.

      • getTemplateType

        IDocumentTemplate.TemplateTypeValue getTemplateType()
        Getter for field TEMPLATETYPE

        Document template type

        The type of document template. Available types of document template are:

        • EXITPGM - An exit program.
        • FILE - A file.
        • HFS - An HFS file.
        • MEMBER - A member of a partitioned dataset.
        • PROGRAM - A program.
        • TDQUEUE - A transient data queue.
        • TSQUEUE - A temporary storage queue.

      • getTemplateName

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

        Extended document template name

        The full name of the document template.

      • getDSName

        java.lang.String getDSName()
        Getter for field DSNAME

        Data set name of partitioned data set

        The data set name (dsname) for the document template.

      • getContentType

        IDocumentTemplate.ContentTypeValue getContentType()
        Getter for field DOCTYPE

        Document content type

        The data type of the contents of the document. Values are BINARY or EBCDIC.

      • getAppendCRLF

        IDocumentTemplate.AppendCRLFValue getAppendCRLF()
        Getter for field APPENDCRLF

        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.

      • getHFSFile

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

        zSeries File System template file

        The name of the zSeries File System (zFS) template file

      • getNewcopyStatus

        IDocumentTemplate.NewcopyStatusValue getNewcopyStatus()
        Getter for field COPY

        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.

      • getCacheSize

        java.lang.Long getCacheSize()
        Getter for field CACHESIZE

        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.

      • getUseCount

        java.lang.Long getUseCount()
        Getter for field USECOUNT

        Total number of times DOCTEMPLATE has been used

        The total number of times the document template was referenced for any reason.

      • getNewcopyCount

        java.lang.Long getNewcopyCount()
        Getter for field NEWCOPYCNT

        Total number of NEWCOPY requests issued

        The number of times the SET DOCTEMPLATE NEWCOPY command was issued for this document template.

      • getReadCount

        java.lang.Long getReadCount()
        Getter for field READCOUNT

        Total number of DOCTEMPLATE reads

        The number of times the document template was read from the source.

      • getCacheUseCount

        java.lang.Long getCacheUseCount()
        Getter for field CACHEUSED

        Total number of DOCTEMPLATE accesses from Cache

        The number of times an application used the cached copy of the document template.

      • getCacheDeleteCount

        java.lang.Long getCacheDeleteCount()
        Getter for field CACHEDELD

        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.

      • getChangeUserID

        java.lang.String getChangeUserID()
        Getter for field CHANGEUSRID

        Last modification user ID

        The user ID that made the last modification to the resource definition.

      • getChangeAgent

        IDocumentTemplate.ChangeAgentValue getChangeAgent()
        Getter for field CHANGEAGENT

        Last 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 - The resource was last changed by a CICSPlex SM BAS API command.
        • DREPBATCH - The resource was last changed by a CICSPlex SM utility.
        • DYNAMIC - The resource was last changed dynamically.
        • CREATESPI - The resource was last changed by an EXEC CICS CREATE command.
        • NOTAPPLIC - This is not applicable for this resource.
        • OVERRIDE - Resource was last changed by resource overrides.
        • N_A - Resource was created or last updated prior to CICS TS Version 4 Release 1 and support for resource signatures.
      • getChangeAgentRelease

        java.lang.String getChangeAgentRelease()
        Getter for field CHANGEAGREL

        Last modification agent release

        The CICS release level of the agent that made the last modification to the resource definition.

      • getChangeTime

        java.util.Date getChangeTime()
        Getter for field CHANGETIME

        Last modification time

        The local date and time when the definition was last changed.

      • getDefineSource

        java.lang.String getDefineSource()
        Getter for field DEFINESOURCE

        Source of the resource definition

        The source of the definition, depending on which agent made the last change.

      • getDefineTime

        java.util.Date getDefineTime()
        Getter for field DEFINETIME

        Creation time

        The local date and time when the resource definition record was created on DFHCSD or EYUDREP.

      • getInstallUserID

        java.lang.String getInstallUserID()
        Getter for field INSTALLUSRID

        Installation user ID

        The user ID that installed the resource definition.

      • getInstallTime

        java.util.Date getInstallTime()
        Getter for field INSTALLTIME

        Installation time

        The local date and time when the definition was installed.

      • getInstallAgent

        IDocumentTemplate.InstallAgentValue getInstallAgent()
        Getter for field INSTALLAGENT

        Installation agent

        The install agent identifier that made the installation.

        • CSDAPI - The resource was installed by a CEDA transaction, by the programmable interface to DFHEDAP or by an EXEC CICS CSD command.
        • CREATESPI - The resource was installed by an EXEC CICS CREATE command.
        • GRPLIST - The resource was installed by GRPLIST INSTALL.
        • DYNAMIC - The resource was installed dynamically.
      • getBasdefinever

        java.lang.Long getBasdefinever()
        Getter for field BASDEFINEVER

        BAS resource definition version

        The BAS version number of this definition.