Interface ITSModelDefinition
-
- All Superinterfaces:
ICICSDefinition,ICICSObject,IDefinition,com.ibm.cics.model.meta.ITypedObject
public interface ITSModelDefinition extends ICICSDefinition
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classITSModelDefinition.ChangeAgentValueEnumeration type for field CHANGEAGENTstatic classITSModelDefinition.LocationValueEnumeration type for field LOCATION
-
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 ITSModelDefinition.ChangeAgentValuegetChangeAgent()Getter for field CHANGEAGENTICICSDefinitionReference<ITSModelDefinition>getCICSObjectReference()java.lang.LonggetExpiryint()Getter for field EXPIRYINTjava.lang.LonggetExpiryintmin()Getter for field EXPIRYINTMINITSModelDefinition.LocationValuegetLocation()Getter for field LOCATIONICICSType<ITSModelDefinition>getObjectType()java.lang.StringgetPoolname()Getter for field POOLNAMEjava.lang.StringgetPrefix()Getter for field PREFIXICICSEnums.YesNoValuegetRecovery()Getter for field RECOVERYjava.lang.StringgetRemoteprefix()Getter for field REMOTEPREFIXjava.lang.StringgetRemotesystem()Getter for field REMOTESYSTEMICICSEnums.YesNoValuegetSecurity()Getter for field SECURITYjava.lang.StringgetUserdata1()Getter for field USERDATA1java.lang.StringgetUserdata2()Getter for field USERDATA2java.lang.StringgetUserdata3()Getter for field USERDATA3java.lang.StringgetXprefix()Getter for field XPREFIXjava.lang.StringgetXremotepfx()Getter for field XREMOTEPFX-
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<ITSModelDefinition> getObjectType()
- Specified by:
getObjectTypein interfaceICICSDefinition- Specified by:
getObjectTypein interfaceICICSObject- Specified by:
getObjectTypein interfaceIDefinition- Specified by:
getObjectTypein interfacecom.ibm.cics.model.meta.ITypedObject
-
getChangeAgent
ITSModelDefinition.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.
-
getPrefix
java.lang.String getPrefix()
Getter for field PREFIXTS 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 LOCATIONQueue 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.
-
getRecovery
ICICSEnums.YesNoValue getRecovery()
Getter for field RECOVERYRecovery option
Specifies whether or not queues matching this model are to be recoverable.
-
getSecurity
ICICSEnums.YesNoValue getSecurity()
Getter for field SECURITYSecurity option
Specifies whether security checking is to be performed for queues matching this model.
-
getPoolname
java.lang.String getPoolname()
Getter for field POOLNAMEShared 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 REMOTESYSTEMRemote 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 REMOTEPREFIXRemote 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 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.
-
getXprefix
java.lang.String getXprefix()
Getter for field XPREFIXHexadecimal 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 XREMOTEPFXHexadecimal 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 EXPIRYINTTS 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 EXPIRYINTMINTS 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.
-
getCICSObjectReference
ICICSDefinitionReference<ITSModelDefinition> getCICSObjectReference()
- Specified by:
getCICSObjectReferencein interfaceICICSDefinition- Specified by:
getCICSObjectReferencein interfaceICICSObject- Specified by:
getCICSObjectReferencein interfaceIDefinition
-
-