|
Primavera Integration API 6.1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.primavera.integration.collab.CollabProperties
public abstract class CollabProperties
Abstract base class for collaboration properties.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface java.util.Map |
---|
Map.Entry<K,V> |
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 |
---|
public static final String PROPKEY_ACTIVITY
public static final String PROPKEY_IS_CHECKED_OUT
public static final String PROPKEY_CHILDREN_COUNT
public static final String PROPKEY_COMMENT
public static final String PROPKEY_DATE
public static final String PROPKEY_DATE_CHECKED_OUT
public static final String PROPKEY_DATE_CREATED
public static final String PROPKEY_DATE_MODIFIED
public static final String PROPKEY_DESCRIPTION
public static final String PROPKEY_FILE_EXTENSION
public static final String PROPKEY_ID_DOCUMENT
public static final String PROPKEY_ID_FOLDER
public static final String PROPKEY_ID_PARENT
public static final String PROPKEY_ID_VERSION
public static final String PROPKEY_IS_LATEST_VERSION
public static final String PROPKEY_IS_UNDER_REVIEW
public static final String PROPKEY_NAME
public static final String PROPKEY_OBJECTID_CHECKED_OUT_BY
public static final String PROPKEY_OBJECTID_DOCUMENT
public static final String PROPKEY_OBJECTID_MODIFIED_BY
public static final String PROPKEY_OBJECTID_PROJECT
public static final String PROPKEY_OBJECTID_USER
public static final String PROPKEY_SECURITY_POLICY
public static final String PROPKEY_OBJECTID_CREATED_BY
public static final String PROPKEY_SIZE
public static final String PROPKEY_TITLE
public static final String PROPKEY_VERSION_NUMBER
public static final String KEYTYPE_DOCUMENTID
public static final String KEYTYPE_VERSIONID
public static final String KEYTYPE_FOLDERID
public static final String KEYTYPE_BOOLEAN
public static final String KEYTYPE_DATE
public static final String KEYTYPE_INTEGER
public static final String KEYTYPE_LONG
public static final String KEYTYPE_OBJECTID
public static final String KEYTYPE_STRING
Method Detail |
---|
public abstract Set validKeySet()
public boolean isEmpty()
isEmpty
in interface Map
public boolean getPropertyAsBoolean(String key)
key
- key whose associated value is to be returned.
IllegalArgumentException
- if the key is not a valid key for this class or if the
key's value is not of type booleanpublic Date getPropertyAsDate(String key)
key
- key whose associated value is to be returned.
IllegalArgumentException
- if the key is not a valid key for this class or if the
key's value is not of type Datepublic int getPropertyAsInteger(String key)
key
- key whose associated value is to be returned.
IllegalArgumentException
- if the key is not a valid key for this class or if the
key's value is not of type intpublic String getPropertyAsString(String key)
key
- key whose associated value is to be returned.
IllegalArgumentException
- if the key is not a valid key for this class or if the
key's value is not of type Stringpublic long getPropertyAsLong(String key)
key
- key whose associated value is to be returned.
IllegalArgumentException
- if the key is not a valid key for this class or if the
key's value is not of type longpublic ObjectId getPropertyAsObjectId(String key)
key
- key whose associated value is to be returned.
IllegalArgumentException
- if the key is not a valid key for this class or if the
key's value is not of type ObjectIdpublic String getPropertyType(String key)
key
- key whose type is to be returned
IllegalArgumentException
- if the input parameter is null or invalidpublic void clear()
clear
in interface Map
UnsupportedOperationException
public boolean containsKey(Object key)
containsKey
in interface Map
key
- key whose presence in this map is to be tested.
IllegalArgumentException
- if the key is nullpublic boolean containsValue(Object value)
containsValue
in interface Map
value
- value whose presence in this map is to be tested.
public Set entrySet()
entrySet
in interface Map
public boolean equals(Object o)
equals
in interface Map
equals
in class Object
o
- object to be compared for equality with this map
public Object get(Object key)
get
in interface Map
key
- key whose associated value is to be returned.
IllegalArgumentException
- if the key is null and this map does not not permit null keys
(optional).public int hashCode()
hashCode
in interface Map
hashCode
in class Object
public Set keySet()
keySet
in interface Map
public Object put(Object key, Object value)
put
in interface Map
key
- key with which the specified value is to be associated.value
- value to be associated with the specified key.
IllegalArgumentException
- the key is not valid or not writable or the specified key is null
IllegalStateException
- the internal state is not validpublic void putAll(Map t)
putAll
in interface Map
t
- mappings to be stored in this map
IllegalArgumentException
- the specified map is nullpublic Object remove(Object key)
remove
in interface Map
key
- the key to remove
UnsupportedOperationException
- The operation is not supportedpublic int size()
size
in interface Map
public String toString()
toString
in class Object
public Collection values()
values
in interface Map
|
Primavera Integration API 6.1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |