com.ibm.rpm.applicationadministration.containers
Geographical

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

Geographical
Extends: com.ibm.rpm.framework.RPMObject
Child objects:
   com.ibm.rpm.applicationadministration.containers.City
   com.ibm.rpm.applicationadministration.containers.Country
   com.ibm.rpm.applicationadministration.containers.CountryState
   com.ibm.rpm.applicationadministration.containers.Location
   com.ibm.rpm.applicationadministration.containers.Region

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

A Geographical represents a geographical position which can be defined for a Resource. Geographical sub types that can be defined are Region, Country, CountryState, City, and Location.

Creation restrictions: This object may not be created. The database contains a fixed number of those objects that may be updated.

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

ID

Related code samples :

Java

C#

Field Summary
Geographical[] children
    Array of child geographical objects. The valid type of children depends on the type of the parent.
xsd:string description
   Description of the geographical.
xsd:string name
   Name of the geographical.

Inherited Field Summary
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 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.
RPMObject parent
   The parent of the RPMObject.

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.Country
com.ibm.rpm.applicationadministration.containers.CountryState
com.ibm.rpm.applicationadministration.containers.Location
com.ibm.rpm.applicationadministration.containers.Region

description


xsd:string  description
Description of the geographical.

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


name


xsd:string  name
Name of the geographical.

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


Inherited Field Detail

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.


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.


parent


RPMObject parent
The parent of the RPMObject.

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.