Primavera Integration API 6.1

com.primavera.integration.collab
Class FolderProperties

java.lang.Object
  extended by com.primavera.integration.collab.CollabProperties
      extended by com.primavera.integration.collab.ItemProperties
          extended by com.primavera.integration.collab.FolderProperties
All Implemented Interfaces:
Serializable, Map

public class FolderProperties
extends ItemProperties
implements Serializable

Collaboration properties for folders.

The property keys used in this class are:

  • CollabProperties.PROPKEY_ID_FOLDER
  • CollabProperties.PROPKEY_ID_PARENT
  • CollabProperties.PROPKEY_CHILDREN_COUNT
  • CollabProperties.PROPKEY_NAME
  • CollabProperties.PROPKEY_OBJECTID_CREATED_BY
  • CollabProperties.PROPKEY_SECURITY_POLICY

    See Also:
    Serialized Form

    Nested Class Summary
     
    Nested classes/interfaces inherited from interface java.util.Map
    Map.Entry<K,V>
     
    Field Summary
     
    Fields inherited from class com.primavera.integration.collab.CollabProperties
    KEYTYPE_BOOLEAN, KEYTYPE_DATE, KEYTYPE_DOCUMENTID, KEYTYPE_FOLDERID, KEYTYPE_INTEGER, KEYTYPE_LONG, KEYTYPE_OBJECTID, KEYTYPE_STRING, KEYTYPE_VERSIONID, PROPKEY_ACTIVITY, PROPKEY_CHILDREN_COUNT, PROPKEY_COMMENT, PROPKEY_DATE, PROPKEY_DATE_CHECKED_OUT, PROPKEY_DATE_CREATED, PROPKEY_DATE_MODIFIED, PROPKEY_DESCRIPTION, PROPKEY_FILE_EXTENSION, PROPKEY_ID_DOCUMENT, PROPKEY_ID_FOLDER, PROPKEY_ID_PARENT, PROPKEY_ID_VERSION, PROPKEY_IS_CHECKED_OUT, PROPKEY_IS_LATEST_VERSION, PROPKEY_IS_UNDER_REVIEW, PROPKEY_NAME, PROPKEY_OBJECTID_CHECKED_OUT_BY, PROPKEY_OBJECTID_CREATED_BY, PROPKEY_OBJECTID_DOCUMENT, PROPKEY_OBJECTID_MODIFIED_BY, PROPKEY_OBJECTID_PROJECT, PROPKEY_OBJECTID_USER, PROPKEY_SECURITY_POLICY, PROPKEY_SIZE, PROPKEY_TITLE, PROPKEY_VERSION_NUMBER
     
    Constructor Summary
    FolderProperties()
              Default class constructor
    FolderProperties(Map prop)
              Class constructor allowing the internal map to be set
     
    Method Summary
     boolean equals(Object o)
              Compares the specified object with this property map for equality.
     FolderId getId()
              Returns the FolderId of the folder described by these properties
     DocumentManagementSecurityPolicy getSecurityPolicy()
              Returns the DocumentManagementSecurityPolicy assigned to the folder.
     int hashCode()
              Returns the hash code value for this properties map.
     Set<String> validKeySet()
              Returns an unmodifiable set of all possible valid keys for this properties class
     
    Methods inherited from class com.primavera.integration.collab.CollabProperties
    clear, containsKey, containsValue, entrySet, get, getPropertyAsBoolean, getPropertyAsDate, getPropertyAsInteger, getPropertyAsLong, getPropertyAsObjectId, getPropertyAsString, getPropertyType, isEmpty, keySet, put, putAll, remove, size, toString, values
     
    Methods inherited from class java.lang.Object
    getClass, notify, notifyAll, wait, wait, wait
     

    Constructor Detail

    FolderProperties

    public FolderProperties()
    Default class constructor


    FolderProperties

    public FolderProperties(Map prop)
    Class constructor allowing the internal map to be set

    Parameters:
    prop - map of all set properties
    Method Detail

    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 ItemProperties
    Parameters:
    o - object to be compared for equality with this map
    Returns:
    boolean true if the specified object is equal to this map

    hashCode

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

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

    validKeySet

    public Set<String> validKeySet()
    Returns an unmodifiable set of all possible valid keys for this properties class

    Specified by:
    validKeySet in class CollabProperties
    Returns:
    Set the set of possible keys

    getId

    public FolderId getId()
    Returns the FolderId of the folder described by these properties

    Returns:
    FolderId the unique id of the folder

    getSecurityPolicy

    public DocumentManagementSecurityPolicy getSecurityPolicy()
    Returns the DocumentManagementSecurityPolicy assigned to the folder.

    Returns:
    the DocumentManagementSecurityPolicy assigned
    Since:
    Version 5.0

    Primavera Integration API 6.1

    Copyright © Primavera 1999-2007. All rights reserved.