com.ibm.rpm.applicationadministration.containers
CountryState

com.ibm.rpm.framework.RPMObject
  extended bycom.ibm.rpm.applicationadministration.containers.Geographical
   extended bycom.ibm.rpm.applicationadministration.containers.CountryState

CountryState
Extends: com.ibm.rpm.applicationadministration.containers.Geographical
Child objects: None

Related scope: com.ibm.rpm.applicationadministration.scope.GeographicalScope

Represents a state or province, it can be defined for a Resource. Geographical sub types that can be defined are Region, Country, CountryState, City, and Location.

Parent is mandatory, allowed parent types are Country and Region.

Supported API Calls: Primary key: The following fields are required when using the loadFromID and loadArrayFromID methods:

ID

Related code samples :

Java

C#

Inherited Field Summary
Geographical[] children
    Array of child geographical objects. The valid type of children depends on the type of the parent.
xsd:string contextName
   The context name identifies which section of the Web Services API the object belongs to. This value of this field is generated automatically when creating the RPMObject.
xsd:boolean deleted
   If the value of this field is set to true, then the RPMObject will be deleted when performing a save.
xsd:string description
   Description of the geographical.
xsd:string ID
   The unique ID of the RPMObject. If the value of this field is set to null, the save operation will generate the ID automatically when creating the RPMObject. If an ID is specified, then the save operation will attempt to update an existing RPMObject.
xsd:string name
   Name of the geographical.
RPMObject parent
   The parent of the RPMObject.

Inherited Field Detail

children


Geographical[] children
Array of child geographical objects. The valid type of children depends on the type of the parent.

Scoping: This field will be used by the API if the scope field children is enabled.

Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.

Valid types:
com.ibm.rpm.applicationadministration.containers.City
com.ibm.rpm.applicationadministration.containers.Location

contextName


xsd:string  contextName
The context name identifies which section of the Web Services API the object belongs to. This value of this field is generated automatically when creating the RPMObject.

Read-only behavior: The value of this field is read only.

X-Path availability: This field doesn't support X-Path queries.


deleted


xsd:boolean  deleted
If the value of this field is set to true, then the RPMObject will be deleted when performing a save.

Read-only behavior: The value of this field is read only.

X-Path availability: This field doesn't support X-Path queries.


description


xsd:string  description
Description of the geographical.

Maximum: The maximum length for this field is 50 characters.


ID


xsd:string  ID
The unique ID of the RPMObject. If the value of this field is set to null, the save operation will generate the ID automatically when creating the RPMObject. If an ID is specified, then the save operation will attempt to update an existing RPMObject.

Read-only behavior: The value of this field is read only.


name


xsd:string  name
Name of the geographical.

Maximum: The maximum length for this field is 50 characters.


parent


RPMObject parent
The parent of the RPMObject.

Null value: This field may never be null.

Scoping: This field will be used by the API if the scope field parent is enabled.

Read-only behavior: The value of this field is read only after the object was created.

Relationship: This field is a reference relationship.

X-Path availability: This field doesn't support X-Path queries.

Valid types:
com.ibm.rpm.applicationadministration.containers.Region
com.ibm.rpm.applicationadministration.containers.Country