Primavera Integration API 6.1

com.primavera.integration.collab
Class CollabProperties

java.lang.Object
  extended by com.primavera.integration.collab.CollabProperties
All Implemented Interfaces:
Serializable, Map
Direct Known Subclasses:
HistoryEventProperties, ItemProperties

public abstract class CollabProperties
extends Object
implements Serializable, Map

Abstract base class for collaboration properties.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>
 
Field Summary
static String KEYTYPE_BOOLEAN
           
static String KEYTYPE_DATE
           
static String KEYTYPE_DOCUMENTID
           
static String KEYTYPE_FOLDERID
           
static String KEYTYPE_INTEGER
           
static String KEYTYPE_LONG
           
static String KEYTYPE_OBJECTID
           
static String KEYTYPE_STRING
           
static String KEYTYPE_VERSIONID
           
static String PROPKEY_ACTIVITY
           
static String PROPKEY_CHILDREN_COUNT
           
static String PROPKEY_COMMENT
           
static String PROPKEY_DATE
           
static String PROPKEY_DATE_CHECKED_OUT
           
static String PROPKEY_DATE_CREATED
           
static String PROPKEY_DATE_MODIFIED
           
static String PROPKEY_DESCRIPTION
           
static String PROPKEY_FILE_EXTENSION
           
static String PROPKEY_ID_DOCUMENT
           
static String PROPKEY_ID_FOLDER
           
static String PROPKEY_ID_PARENT
           
static String PROPKEY_ID_VERSION
           
static String PROPKEY_IS_CHECKED_OUT
           
static String PROPKEY_IS_LATEST_VERSION
           
static String PROPKEY_IS_UNDER_REVIEW
           
static String PROPKEY_NAME
           
static String PROPKEY_OBJECTID_CHECKED_OUT_BY
           
static String PROPKEY_OBJECTID_CREATED_BY
           
static String PROPKEY_OBJECTID_DOCUMENT
           
static String PROPKEY_OBJECTID_MODIFIED_BY
           
static String PROPKEY_OBJECTID_PROJECT
           
static String PROPKEY_OBJECTID_USER
           
static String PROPKEY_SECURITY_POLICY
           
static String PROPKEY_SIZE
           
static String PROPKEY_TITLE
           
static String PROPKEY_VERSION_NUMBER
           
 
Method Summary
 void clear()
          Unsupported method for removing all mappings from this map.
 boolean containsKey(Object key)
          Returns true if this map contains a mapping for the specified key.
 boolean containsValue(Object value)
          Returns true if this property map maps one or more keys to the specified value.
 Set entrySet()
          Returns an unmodifiable set view of the mappings contained in this property map.
 boolean equals(Object o)
          Compares the specified object with this property map for equality.
 Object get(Object key)
          Returns the value to which this property map maps the specified key.
 boolean getPropertyAsBoolean(String key)
          Returns the value of the specified key as a boolean.
 Date getPropertyAsDate(String key)
          Returns the value of the specified key as a Date.
 int getPropertyAsInteger(String key)
          Returns the value of the specified key as an int.
 long getPropertyAsLong(String key)
          Returns the value of the specified key as a long.
 ObjectId getPropertyAsObjectId(String key)
          Returns the value of the specified key as an ObjectId.
 String getPropertyAsString(String key)
          Returns the value of the specified key as a String.
 String getPropertyType(String key)
          Returns the type of a particular property.
 int hashCode()
          Returns the hash code value for this properties map.
 boolean isEmpty()
          Returns true if this map contains no key-value mappings.
 Set keySet()
          Returns an unmodifiable set view of the keys contained in this property map.
 Object put(Object key, Object value)
          Associates the specified value with the specified key in this map.
 void putAll(Map t)
          Copies all of the mappings from the specified map to this map.
 Object remove(Object key)
          Unsupported method for removing the mapping for this key from this map.
 int size()
          Returns the number of key-value mappings in this map.
 String toString()
          Returns a string representation of the object.
abstract  Set validKeySet()
          Returns an unmodifiable set of all possible valid keys for this properties class.
 Collection values()
          Returns an unmodifiable collection view of the values contained in this property map.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

PROPKEY_ACTIVITY

public static final String PROPKEY_ACTIVITY
See Also:
Constant Field Values

PROPKEY_IS_CHECKED_OUT

public static final String PROPKEY_IS_CHECKED_OUT
See Also:
Constant Field Values

PROPKEY_CHILDREN_COUNT

public static final String PROPKEY_CHILDREN_COUNT
See Also:
Constant Field Values

PROPKEY_COMMENT

public static final String PROPKEY_COMMENT
See Also:
Constant Field Values

PROPKEY_DATE

public static final String PROPKEY_DATE
See Also:
Constant Field Values

PROPKEY_DATE_CHECKED_OUT

public static final String PROPKEY_DATE_CHECKED_OUT
See Also:
Constant Field Values

PROPKEY_DATE_CREATED

public static final String PROPKEY_DATE_CREATED
See Also:
Constant Field Values

PROPKEY_DATE_MODIFIED

public static final String PROPKEY_DATE_MODIFIED
See Also:
Constant Field Values

PROPKEY_DESCRIPTION

public static final String PROPKEY_DESCRIPTION
See Also:
Constant Field Values

PROPKEY_FILE_EXTENSION

public static final String PROPKEY_FILE_EXTENSION
See Also:
Constant Field Values

PROPKEY_ID_DOCUMENT

public static final String PROPKEY_ID_DOCUMENT
See Also:
Constant Field Values

PROPKEY_ID_FOLDER

public static final String PROPKEY_ID_FOLDER
See Also:
Constant Field Values

PROPKEY_ID_PARENT

public static final String PROPKEY_ID_PARENT
See Also:
Constant Field Values

PROPKEY_ID_VERSION

public static final String PROPKEY_ID_VERSION
See Also:
Constant Field Values

PROPKEY_IS_LATEST_VERSION

public static final String PROPKEY_IS_LATEST_VERSION
See Also:
Constant Field Values

PROPKEY_IS_UNDER_REVIEW

public static final String PROPKEY_IS_UNDER_REVIEW
See Also:
Constant Field Values

PROPKEY_NAME

public static final String PROPKEY_NAME
See Also:
Constant Field Values

PROPKEY_OBJECTID_CHECKED_OUT_BY

public static final String PROPKEY_OBJECTID_CHECKED_OUT_BY
See Also:
Constant Field Values

PROPKEY_OBJECTID_DOCUMENT

public static final String PROPKEY_OBJECTID_DOCUMENT
See Also:
Constant Field Values

PROPKEY_OBJECTID_MODIFIED_BY

public static final String PROPKEY_OBJECTID_MODIFIED_BY
See Also:
Constant Field Values

PROPKEY_OBJECTID_PROJECT

public static final String PROPKEY_OBJECTID_PROJECT
See Also:
Constant Field Values

PROPKEY_OBJECTID_USER

public static final String PROPKEY_OBJECTID_USER
See Also:
Constant Field Values

PROPKEY_SECURITY_POLICY

public static final String PROPKEY_SECURITY_POLICY
See Also:
Constant Field Values

PROPKEY_OBJECTID_CREATED_BY

public static final String PROPKEY_OBJECTID_CREATED_BY
See Also:
Constant Field Values

PROPKEY_SIZE

public static final String PROPKEY_SIZE
See Also:
Constant Field Values

PROPKEY_TITLE

public static final String PROPKEY_TITLE
See Also:
Constant Field Values

PROPKEY_VERSION_NUMBER

public static final String PROPKEY_VERSION_NUMBER
See Also:
Constant Field Values

KEYTYPE_DOCUMENTID

public static final String KEYTYPE_DOCUMENTID
See Also:
Constant Field Values

KEYTYPE_VERSIONID

public static final String KEYTYPE_VERSIONID
See Also:
Constant Field Values

KEYTYPE_FOLDERID

public static final String KEYTYPE_FOLDERID
See Also:
Constant Field Values

KEYTYPE_BOOLEAN

public static final String KEYTYPE_BOOLEAN
See Also:
Constant Field Values

KEYTYPE_DATE

public static final String KEYTYPE_DATE
See Also:
Constant Field Values

KEYTYPE_INTEGER

public static final String KEYTYPE_INTEGER
See Also:
Constant Field Values

KEYTYPE_LONG

public static final String KEYTYPE_LONG
See Also:
Constant Field Values

KEYTYPE_OBJECTID

public static final String KEYTYPE_OBJECTID
See Also:
Constant Field Values

KEYTYPE_STRING

public static final String KEYTYPE_STRING
See Also:
Constant Field Values
Method Detail

validKeySet

public abstract Set validKeySet()
Returns an unmodifiable set of all possible valid keys for this properties class.

Returns:
Set the set of possible keys

isEmpty

public boolean isEmpty()
Returns true if this map contains no key-value mappings.

Specified by:
isEmpty in interface Map
Returns:
boolean true if this map contains no key-value mappings.

getPropertyAsBoolean

public boolean getPropertyAsBoolean(String key)
Returns the value of the specified key as a boolean.

Parameters:
key - key whose associated value is to be returned.
Returns:
boolean the boolean value associated with the specified key
Throws:
IllegalArgumentException - if the key is not a valid key for this class or if the key's value is not of type boolean

getPropertyAsDate

public Date getPropertyAsDate(String key)
Returns the value of the specified key as a Date.

Parameters:
key - key whose associated value is to be returned.
Returns:
Date the Date value associated with the specified key
Throws:
IllegalArgumentException - if the key is not a valid key for this class or if the key's value is not of type Date

getPropertyAsInteger

public int getPropertyAsInteger(String key)
Returns the value of the specified key as an int.

Parameters:
key - key whose associated value is to be returned.
Returns:
int the int value associated with the specified key
Throws:
IllegalArgumentException - if the key is not a valid key for this class or if the key's value is not of type int

getPropertyAsString

public String getPropertyAsString(String key)
Returns the value of the specified key as a String.

Parameters:
key - key whose associated value is to be returned.
Returns:
String the String value associated with the specified key
Throws:
IllegalArgumentException - if the key is not a valid key for this class or if the key's value is not of type String

getPropertyAsLong

public long getPropertyAsLong(String key)
Returns the value of the specified key as a long.

Parameters:
key - key whose associated value is to be returned.
Returns:
long the long value associated with the specified key
Throws:
IllegalArgumentException - if the key is not a valid key for this class or if the key's value is not of type long

getPropertyAsObjectId

public ObjectId getPropertyAsObjectId(String key)
Returns the value of the specified key as an ObjectId.

Parameters:
key - key whose associated value is to be returned.
Returns:
long the ObjectId value associated with the specified key
Throws:
IllegalArgumentException - if the key is not a valid key for this class or if the key's value is not of type ObjectId

getPropertyType

public String getPropertyType(String key)
Returns the type of a particular property. The type is a String constant defined in CollabProperties.

Parameters:
key - key whose type is to be returned
Returns:
String the type defined in CollabProperties
Throws:
IllegalArgumentException - if the input parameter is null or invalid

clear

public void clear()
Unsupported method for removing all mappings from this map.

Specified by:
clear in interface Map
Throws:
UnsupportedOperationException

containsKey

public boolean containsKey(Object key)
Returns true if this map contains a mapping for the specified key.

Specified by:
containsKey in interface Map
Parameters:
key - key whose presence in this map is to be tested.
Returns:
boolean true if this map contains a mapping for the specified key.
Throws:
IllegalArgumentException - if the key is null

containsValue

public boolean containsValue(Object value)
Returns true if this property map maps one or more keys to the specified value.

Specified by:
containsValue in interface Map
Parameters:
value - value whose presence in this map is to be tested.
Returns:
boolean true if this map maps one or more keys to the specified value

entrySet

public Set entrySet()
Returns an unmodifiable set view of the mappings contained in this property map. Each element in the returned set is a Map.Entry. The set is not backed by the map, so changes to the map are not reflected in the set.

Specified by:
entrySet in interface Map
Returns:
Set a set view of the mappings contained in this map

equals

public boolean equals(Object o)
Compares the specified object with this property map for equality. Returns true if the given object is also a map and the two Maps represent the same mappings.

Specified by:
equals in interface Map
Overrides:
equals in class Object
Parameters:
o - object to be compared for equality with this map
Returns:
boolean true if the specified object is equal to this map

get

public Object get(Object key)
Returns the value to which this property map maps the specified key. Returns null if the map contains no mapping for this key. A return value of null does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to null. The containsKey operation may be used to distinguish these two cases.

Specified by:
get in interface Map
Parameters:
key - key whose associated value is to be returned.
Returns:
int the hash code value for this map.
Throws:
IllegalArgumentException - if the key is null and this map does not not permit null keys (optional).

hashCode

public int hashCode()
Returns the hash code value for this properties map.

Specified by:
hashCode in interface Map
Overrides:
hashCode in class Object
Returns:
int the hash code value for this map.

keySet

public Set keySet()
Returns an unmodifiable set view of the keys contained in this property map. The set is not backed by the map, so changes to the map are not reflected in the set.

Specified by:
keySet in interface Map
Returns:
Set a set view of the keys contained in this map.

put

public Object put(Object key,
                  Object value)
Associates the specified value with the specified key in this map.

Specified by:
put in interface Map
Parameters:
key - key with which the specified value is to be associated.
value - value to be associated with the specified key.
Returns:
Object previous value associated with specified key, or null if there was no mapping for key. A null return can also indicate that the map previously associated null with the specified key.
Throws:
IllegalArgumentException - the key is not valid or not writable or the specified key is null
IllegalStateException - the internal state is not valid

putAll

public void putAll(Map t)
Copies all of the mappings from the specified map to this map. The effect of this call is equivalent to that of calling put(k, v) on this map once for each mapping from key k to value v in the specified map. The behavior of this operation is unspecified if the specified map is modified while the operation is in progress.

Specified by:
putAll in interface Map
Parameters:
t - mappings to be stored in this map
Throws:
IllegalArgumentException - the specified map is null

remove

public Object remove(Object key)
Unsupported method for removing the mapping for this key from this map.

Specified by:
remove in interface Map
Parameters:
key - the key to remove
Returns:
Object this operation is not supported
Throws:
UnsupportedOperationException - The operation is not supported

size

public int size()
Returns the number of key-value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Specified by:
size in interface Map
Returns:
int the number of key-value mappings in this map.

toString

public String toString()
Returns a string representation of the object.

Overrides:
toString in class Object
Returns:
String a string representation of the object.

values

public Collection values()
Returns an unmodifiable collection view of the values contained in this property map. The collection is not backed by the map, so changes to the map are not reflected in the collection, and vice-versa.

Specified by:
values in interface Map
Returns:
Collection a collection view of the values contained in this map.

Primavera Integration API 6.1

Copyright © Primavera 1999-2007. All rights reserved.