com.ibm.rpm.resource.containers
LocationPreferences

com.ibm.rpm.framework.RPMObject
  extended bycom.ibm.rpm.resource.containers.LocationPreferences

LocationPreferences
Extends: com.ibm.rpm.framework.RPMObject
Child objects: None

Related scope: com.ibm.rpm.framework.RPMObjectScope

This object represents the location preferences in regards to a resource’s relocation.

The checkout mode type is: Parent

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

ID

Field Summary
xsd:int acceptableRelocateDuration
    The acceptable relocation duration for a resource
xsd:int acceptableTravelDuration
    The acceptable travel duration for a resource.
CitizenshipCountryCode[] relocateLocations
    The acceptable locations for a resource’s relocation.
CitizenshipCountryCode[] travelLocations
    The acceptable travel locations for a resource.
xsd:boolean willingtoRelocate
    This field is true, if the resource is willing to relocate and is false if the resource is not.
xsd:boolean willingtoTravel
    This field is true, if the resource is willing to travel and is false if the resource is not.

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

acceptableRelocateDuration


xsd:int  acceptableRelocateDuration
The acceptable relocation duration for a resource

Minimum: The minimum value for this field is 0.

Maximum: The maximum value for this field is 9999.

Validation: If the field willingtoRelocate is set to false, then this field must be set to null


acceptableTravelDuration


xsd:int  acceptableTravelDuration
The acceptable travel duration for a resource.

Minimum: The minimum value for this field is 0.

Maximum: The maximum value for this field is 9999.

Validation: If the field willingtoTravel is set to false, then this field must be set to null


relocateLocations


CitizenshipCountryCode[] relocateLocations
The acceptable locations for a resource’s relocation.

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

Validation: If the field willingtoRelocate is set to false, then this field must be set to null

Valid types:
com.ibm.rpm.applicationadministration.containers.CitizenshipCountryCode

travelLocations


CitizenshipCountryCode[] travelLocations
The acceptable travel locations for a resource.

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

Validation: If the field willingtoTravel is set to false, then this field must be set to null

Valid types:
com.ibm.rpm.applicationadministration.containers.CitizenshipCountryCode

willingtoRelocate


xsd:boolean  willingtoRelocate
This field is true, if the resource is willing to relocate and is false if the resource is not.

willingtoTravel


xsd:boolean  willingtoTravel
This field is true, if the resource is willing to travel and is false if the resource is not.

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.

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.resource.containers.Resource