Interface ITSModelDefinition

    • Method Detail

      • getChangeAgent

        ITSModelDefinition.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 - 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.
      • getPrefix

        java.lang.String getPrefix()
        Getter for field PREFIX

        TS queue prefix

        The character string that is to be used as the prefix for this model. The prefix may be up to 16 characters in length.

        You can use either uppercase, or lowercase, or a mixture of the two for the prefix name; lower case is not folded to uppercase. For example, queue prefixes EYUPREFIX, EYUprefix, and eyuprefix identify three different queue models. If you are using CECI, or any other application that does not support mixed case prefix names, you should check that your data is being written to the correct temporary storage queue.

      • getLocation

        ITSModelDefinition.LocationValue getLocation()
        Getter for field LOCATION

        Queue location

        Specifies whether the queue is to be held in auxiliary or main storage:

        • AUXILIARY - Queues matching this model are to be held on auxiliary storage. Whatever is specified on the API request is disregarded.
        • MAIN - Queues matching this model are to be held in main storage. Whatever is specified on the API request is disregarded.
        Note: TSMODEL definitions created using the Migrate command have their location attribute set to the default value AUXILIARY. LOCATION is ignored for remote TSMODELs and shared TS pool models. Using LOCATION on a remote entry allows the same definition to be installed in both a local and remote region.
      • getRecovery

        ICICSEnums.YesNoValue getRecovery()
        Getter for field RECOVERY

        Recovery option

        Specifies whether or not queues matching this model are to be recoverable.

      • getSecurity

        ICICSEnums.YesNoValue getSecurity()
        Getter for field SECURITY

        Security option

        Specifies whether security checking is to be performed for queues matching this model.

      • getPoolname

        java.lang.String getPoolname()
        Getter for field POOLNAME

        Shared TS pool name

        the 8-character name of the shared temporary storage pool definition that you want to use with this TSMODEL definition. The name can be up to eight characters in length.

      • getRemotesystem

        java.lang.String getRemotesystem()
        Getter for field REMOTESYSTEM

        Remote system ID

        The name of the connection that links the local system to the remote system where the temporary storage queue resides. REMOTESYSTEM and POOLNAME are mutually exclusive. If REMOTESYSTEM is specified, POOLNAME is ignored.

      • getRemoteprefix

        java.lang.String getRemoteprefix()
        Getter for field REMOTEPREFIX

        Remote TS queue prefix

        The character string that is to be used as the prefix on the remote system. The prefix may be up to 16 characters in length.

      • 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.

      • getXprefix

        java.lang.String getXprefix()
        Getter for field XPREFIX

        Hexadecimal TS queue prefix

        An alternative to PREFIX. Enter a hexadecimal string, up to 32-characters in length, that is to be used as the prefix for this model. Because XPREFIX is specified in hexadecimal form, you can use a name that contains characters that you cannot enter in the PREFIX attribute. Generic prefix names are allowed, using a single wildcard character, hex 4E

      • getXremotepfx

        java.lang.String getXremotepfx()
        Getter for field XREMOTEPFX

        Hexadecimal remote TS queue prefix

        An alternative to REMOTEPREFIX. Enter a hexadecimal string, up to 32-characters in length, that is to be used as the prefix on the remote system. Because XREMOTEPREFIX is specified in hexadecimal form, you can use a name that contains characters that you cannot enter in the REMOTEPREFIX attribute. Generic prefix names are allowed, using a single wildcard character, hex 4E.

      • getExpiryint

        java.lang.Long getExpiryint()
        Getter for field EXPIRYINT

        TS Queue expiry interval (hours)

        This parameter is deprecated for CICS TS 5.2 and higher, and is ignored if any value for EXPIRYINTMIN is specified. This parameter specifies the last used interval limit time, in hours which is used to determine whether a temporary storage queue based on this TSMODEL has expired and is eligible to be automatically deleted. The value in the TSMODEL at the time a temporary storage queue is created will be used for the lifetime of a queue even if the TSMODEL is subsequently changed. The value of EXPIRYINT can be in the range of 0-to-15000.

        • 0 - Indicates that no expiry interval applies to this TSMODEL and therefore a temporary storage queue based on this will never expire. This is the default value.
        • value - Specifies the last used interval in hours after which the queue becomes eligible for automatic deletion.
      • getExpiryintmin

        java.lang.Long getExpiryintmin()
        Getter for field EXPIRYINTMIN

        TS Queue expiry interval (minutes)

        This parameter applies to CICS TS 5.2 and higher. It specifies the last used interval limit time, in minutes. It overrides any value specified for EXPIRYINT and is used to determine whether a temporary storage queue based on this TSMODEL has expired and is eligible to be automatically deleted. The value in the TSMODEL at the time a temporary storage queue is created will be used for the lifetime of a queue even if the TSMODEL is subsequently changed. The value of EXPIRYINTMIN can be in the range of 0-to-900000.

        • 0 - Indicates that no expiry interval applies to this TSMODEL and therefore a temporary storage queue based on this will never expire. This is the default value.
        • value - Specifies the last used interval in minutes after which the queue becomes eligible for automatic deletion.