com.plumtree.server
Interface IPTDocumentType

All Superinterfaces:
IPTLocalizable, IPTObject, IPTUnknown

public interface IPTDocumentType
extends IPTObject

Interface for IPTDocumentTYpe


Method Summary
 void ClearDefaults()
          Clears the defaults list.
 void ClearOverrides()
          Clears the overrides list
 java.lang.String GetAccessorCLSID()
          GetAccessorCLSID is used to retrieve the GUID of the Accessor associated with this Doc Type.
 int GetAccessorFormatID()
          GetAccessorFormatID is used to retrieve the location format associated with the Accessor that's associated with this DocType.
 int GetApprovalSettings()
          Returns the approval settings
 java.lang.String GetCardOverrideImageUUID()
          Returns the card override image uuid
 IPTQueryResult GetCommonFields()
          GetCommonFields is used to retrieve a SafeArray of common field names and descriptions for this Document Type.
 java.lang.Object[][] GetDefaultsList()
          Gets the defaults list
 byte GetDefaultValueAsByte(int lPropertyID)
          Returns default value of property id as byte
 double GetDefaultValueAsDouble(int lPropertyID)
          Returns default value of property id as double
 float GetDefaultValueAsFloat(int lPropertyID)
          Returns default value of property id as float
 int GetDefaultValueAsInt(int lPropertyID)
          Returns the default values as an int.
 java.lang.Object GetDefaultValueAsObject(int lPropertyID)
          Returns default value of property id as Object
 java.lang.String GetDefaultValueAsString(int lPropertyID)
          Returns the default values as a string.
 com.plumtree.openfoundation.util.XPDateTime GetDefaultValueAsXPDateTime(int lPropertyID)
          Returns default value as XPDateTime
 boolean GetFullTextIndex()
          Returns if this document type has full text index
 java.lang.Object[][] GetOverridesList()
          Returns the Overrides list
 byte GetOverrideValueAsByte(int lPropertyID)
          Returns the override value of a property id as byte.
 double GetOverrideValueAsDouble(int lPropertyID)
          Returns the override value of a property id as double.
 float GetOverrideValueAsFloat(int lPropertyID)
          Returns the override value of a property id as float.
 int GetOverrideValueAsInt(int lPropertyID)
          Returns the override value of a property id as int.
 java.lang.Object GetOverrideValueAsObject(int lPropertyID)
          Returns the override value of a property id as Object.
 java.lang.String GetOverrideValueAsString(int lPropertyID)
          Returns the override value of a property id as String.
 com.plumtree.openfoundation.util.XPDateTime GetOverrideValueAsXPDateTime(int lPropertyID)
          Returns the override value of a property id as XPDateTime.
 IPTPropertyMap GetPropertyMap()
          GetPropertyMap is used to retrieve the PropertyMap associated with this Doc Type.
 java.lang.Object[][] GetRequiredPropertyIDs()
          GetRequiredPropertyIDs retrieves a SafeArray of property IDs that are "required" for cards created from this Document Type
 void SetAccessorCLSID(java.lang.String Value)
          SetAccessorCLSID is used to associate the Doc Type with a particular Accessor.
 void SetApprovalSettings(int Value)
          Sets the approval settings
 void SetDefaultValue(int Value, byte pvValue)
          Sets the default value of a property id.
 void SetDefaultValue(int Value, double pvValue)
          Sets the default value of a property id.
 void SetDefaultValue(int Value, float pvValue)
          Sets the default value of a property id.
 void SetDefaultValue(int Value, int pvValue)
          Sets the default value of a property id.
 void SetDefaultValue(int Value, java.lang.Object pvValue)
          Sets the default value of a property id.
 void SetDefaultValue(int Value, java.lang.String pvValue)
          Sets the default value of a property id.
 void SetDefaultValue(int Value, com.plumtree.openfoundation.util.XPDateTime pvValue)
          Sets the default value of a property id.
 void SetFullTextIndex(boolean Value)
          Sets the document type to have full text indexing
 void SetOverrideValue(int Value, byte pvValue)
          Sets the override value of a given property id
 void SetOverrideValue(int Value, double pvValue)
          Sets the override value of a given property id
 void SetOverrideValue(int Value, float pvValue)
          Sets the override value of a given property id
 void SetOverrideValue(int Value, int pvValue)
          Sets the override value of a given property id
 void SetOverrideValue(int Value, java.lang.Object pvValue)
          Sets the override value of a given property id
 void SetOverrideValue(int Value, java.lang.String pvValue)
          Sets the override value of a given property id
 void SetOverrideValue(int Value, com.plumtree.openfoundation.util.XPDateTime pvValue)
          Sets the override value of a given property id
 void SetRequiredPropertyIDs(java.lang.Object[][] Value)
          SetRequiredPropertyIDs allows the client to specify a SafeArray of Property IDs that are considered "required" for this Doc Type.
 
Methods inherited from interface com.plumtree.server.IPTObject
GetAdminFolderID, GetClassID, GetCreated, GetImageUUID, GetLastModified, GetObjectProperties, SetAdminFolderID, SetImageUUID, SetLastModified
 
Methods inherited from interface com.plumtree.server.IPTLocalizable
GetDescription, GetIsLocalized, GetLocalizedDescription, GetLocalizedDescriptions, GetLocalizedName, GetLocalizedNames, GetName, GetPrimaryLang, GetSupportsLocalization, SetDescription, SetIsLocalized, SetLocalizedDescriptions, SetLocalizedNames, SetName, SetPrimaryLang
 
Methods inherited from interface com.plumtree.server.IPTUnknown
GetInterfaces
 

Method Detail

GetAccessorCLSID

public java.lang.String GetAccessorCLSID()
GetAccessorCLSID is used to retrieve the GUID of the Accessor associated with this Doc Type. This can be used to get info about the Accessor, or instantiate it.
Returns:
clsid string

SetAccessorCLSID

public void SetAccessorCLSID(java.lang.String Value)
SetAccessorCLSID is used to associate the Doc Type with a particular Accessor. This will also affect the Data Format.

GetPropertyMap

public IPTPropertyMap GetPropertyMap()
GetPropertyMap is used to retrieve the PropertyMap associated with this Doc Type. If the PropMap is edited, and the Doc Type is stored, the changes to the PropMap will be stored.
Returns:
IPTPropertyMap

GetAccessorFormatID

public int GetAccessorFormatID()
GetAccessorFormatID is used to retrieve the location format associated with the Accessor that's associated with this DocType. It can be easier to call this than to get it from the Accessor
Returns:
int accessor id

GetDefaultsList

public java.lang.Object[][] GetDefaultsList()
Gets the defaults list
Returns:
Object[][]

ClearDefaults

public void ClearDefaults()
Clears the defaults list.

GetDefaultValueAsInt

public int GetDefaultValueAsInt(int lPropertyID)
Returns the default values as an int.
Parameters:
lPropertyID - property id
Returns:
default value of property id as int

GetDefaultValueAsString

public java.lang.String GetDefaultValueAsString(int lPropertyID)
Returns the default values as a string.
Parameters:
lPropertyID - property id
Returns:
default value of the property id as String

GetDefaultValueAsXPDateTime

public com.plumtree.openfoundation.util.XPDateTime GetDefaultValueAsXPDateTime(int lPropertyID)
Returns default value as XPDateTime
Parameters:
lPropertyID - property id
Returns:
default value of property id as PTDameTime

GetDefaultValueAsFloat

public float GetDefaultValueAsFloat(int lPropertyID)
Returns default value of property id as float
Parameters:
lPropertyID - property id
Returns:
default value of property id as float

GetDefaultValueAsDouble

public double GetDefaultValueAsDouble(int lPropertyID)
Returns default value of property id as double
Parameters:
lPropertyID - property id
Returns:
default value of property id as double

GetDefaultValueAsByte

public byte GetDefaultValueAsByte(int lPropertyID)
Returns default value of property id as byte
Parameters:
lPropertyID - property id
Returns:
default value of property id as byte

GetDefaultValueAsObject

public java.lang.Object GetDefaultValueAsObject(int lPropertyID)
Returns default value of property id as Object
Parameters:
lPropertyID - property id
Returns:
default value of property id as Object

SetDefaultValue

public void SetDefaultValue(int Value,
                            int pvValue)
Sets the default value of a property id.
Parameters:
lPropertyID - property id to set
pvValue - new value of the property id as int

SetDefaultValue

public void SetDefaultValue(int Value,
                            java.lang.String pvValue)
Sets the default value of a property id.
Parameters:
lPropertyID - property id to set
pvValue - new value of the property id as String

SetDefaultValue

public void SetDefaultValue(int Value,
                            com.plumtree.openfoundation.util.XPDateTime pvValue)
Sets the default value of a property id.
Parameters:
lPropertyID - property id to set
pvValue - new value of the property id as XPDateTime

SetDefaultValue

public void SetDefaultValue(int Value,
                            float pvValue)
Sets the default value of a property id.
Parameters:
lPropertyID - property id to set
pvValue - new value of the property id as float

SetDefaultValue

public void SetDefaultValue(int Value,
                            double pvValue)
Sets the default value of a property id.
Parameters:
lPropertyID - property id to set
pvValue - new value of the property id as double

SetDefaultValue

public void SetDefaultValue(int Value,
                            byte pvValue)
Sets the default value of a property id.
Parameters:
lPropertyID - property id to set
pvValue - new value of the property id as byte

SetDefaultValue

public void SetDefaultValue(int Value,
                            java.lang.Object pvValue)
Sets the default value of a property id.
Parameters:
lPropertyID - property id to set
pvValue - new value of the property id as Object

GetOverridesList

public java.lang.Object[][] GetOverridesList()
Returns the Overrides list
Returns:
Object[][] as propid - value pairs

ClearOverrides

public void ClearOverrides()
Clears the overrides list

GetOverrideValueAsInt

public int GetOverrideValueAsInt(int lPropertyID)
Returns the override value of a property id as int.
Parameters:
lPropertyID - property id
Returns:
override value as int

GetOverrideValueAsString

public java.lang.String GetOverrideValueAsString(int lPropertyID)
Returns the override value of a property id as String.
Parameters:
lPropertyID - property id
Returns:
override value as String

GetOverrideValueAsXPDateTime

public com.plumtree.openfoundation.util.XPDateTime GetOverrideValueAsXPDateTime(int lPropertyID)
Returns the override value of a property id as XPDateTime.
Parameters:
lPropertyID - property id
Returns:
override value as XPDateTime

GetOverrideValueAsFloat

public float GetOverrideValueAsFloat(int lPropertyID)
Returns the override value of a property id as float.
Parameters:
lPropertyID - property id
Returns:
override value as float

GetOverrideValueAsDouble

public double GetOverrideValueAsDouble(int lPropertyID)
Returns the override value of a property id as double.
Parameters:
lPropertyID - property id
Returns:
override value as double

GetOverrideValueAsByte

public byte GetOverrideValueAsByte(int lPropertyID)
Returns the override value of a property id as byte.
Parameters:
lPropertyID - property id
Returns:
override value as byte

GetOverrideValueAsObject

public java.lang.Object GetOverrideValueAsObject(int lPropertyID)
Returns the override value of a property id as Object.
Parameters:
lPropertyID - property id
Returns:
override value as Object

SetOverrideValue

public void SetOverrideValue(int Value,
                             int pvValue)
Sets the override value of a given property id
Parameters:
lPropertyID - property id
pvValue - new value as int

SetOverrideValue

public void SetOverrideValue(int Value,
                             java.lang.String pvValue)
Sets the override value of a given property id
Parameters:
lPropertyID - property id
pvValue - new value as String

SetOverrideValue

public void SetOverrideValue(int Value,
                             com.plumtree.openfoundation.util.XPDateTime pvValue)
Sets the override value of a given property id
Parameters:
lPropertyID - property id
pvValue - new value as XPDateTime

SetOverrideValue

public void SetOverrideValue(int Value,
                             float pvValue)
Sets the override value of a given property id
Parameters:
lPropertyID - property id
pvValue - new value as float

SetOverrideValue

public void SetOverrideValue(int Value,
                             double pvValue)
Sets the override value of a given property id
Parameters:
lPropertyID - property id
pvValue - new value as double

SetOverrideValue

public void SetOverrideValue(int Value,
                             byte pvValue)
Sets the override value of a given property id
Parameters:
lPropertyID - property id
pvValue - new value as byte

SetOverrideValue

public void SetOverrideValue(int Value,
                             java.lang.Object pvValue)
Sets the override value of a given property id
Parameters:
lPropertyID - property id
pvValue - new value as Object

GetFullTextIndex

public boolean GetFullTextIndex()
Returns if this document type has full text index
Returns:
true/false

SetFullTextIndex

public void SetFullTextIndex(boolean Value)
Sets the document type to have full text indexing
Parameters:
bFullTextIndex - true/false

GetRequiredPropertyIDs

public java.lang.Object[][] GetRequiredPropertyIDs()
GetRequiredPropertyIDs retrieves a SafeArray of property IDs that are "required" for cards created from this Document Type

SetRequiredPropertyIDs

public void SetRequiredPropertyIDs(java.lang.Object[][] Value)
SetRequiredPropertyIDs allows the client to specify a SafeArray of Property IDs that are considered "required" for this Doc Type.

GetApprovalSettings

public int GetApprovalSettings()
Returns the approval settings
Returns:
int

SetApprovalSettings

public void SetApprovalSettings(int Value)
Sets the approval settings
Parameters:
lApprovalSettings - new approval settings

GetCommonFields

public IPTQueryResult GetCommonFields()
GetCommonFields is used to retrieve a SafeArray of common field names and descriptions for this Document Type. This is basically a pass-through to the Accessor

GetCardOverrideImageUUID

public java.lang.String GetCardOverrideImageUUID()
Returns the card override image uuid
Returns:
String of image uuid


Copyright © 2003 Plumtree Software Inc. All Rights Reserved.