com.plumtree.server
Interface IPTDocumentType

All Superinterfaces:
IPTLocalizable, IPTObject, IPTServerContext, IPTStorable, IPTUnknown

public interface IPTDocumentType
extends IPTObject

Interface for IPTDocumentTYpe

Version:
$Revision$
Author:
ErickS

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
 
Methods inherited from interface com.plumtree.server.IPTServerContext
GetAccessLevel, GetACL, GetLastModifiedBy, GetLockState, GetObjectID, GetOwnerID, GetServerContextSettings, GetSession, GetSettings, LockObject, SetLastModifiedBy, SetObjectID, SetOwnerID, SetServerContextSettings, SetSettings, UnlockObject
 
Methods inherited from interface com.plumtree.server.IPTStorable
Store
 

Method Detail

GetAccessorCLSID

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

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

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

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

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

Returns:
Object[][]

ClearDefaults

void ClearDefaults()
Clears the defaults list.


GetDefaultValueAsInt

int GetDefaultValueAsInt(int lPropertyID)
Returns the default values as an int.

Parameters:
lPropertyID - property id
Returns:
default value of property id as int

GetDefaultValueAsString

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

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

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

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

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

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

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

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

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

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

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

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

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

java.lang.Object[][] GetOverridesList()
Returns the Overrides list

Returns:
Object[][] as propid - value pairs

ClearOverrides

void ClearOverrides()
Clears the overrides list


GetOverrideValueAsInt

int GetOverrideValueAsInt(int lPropertyID)
Returns the override value of a property id as int.

Parameters:
lPropertyID - property id
Returns:
override value as int

GetOverrideValueAsString

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

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

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

Parameters:
lPropertyID - property id
Returns:
override value as float

GetOverrideValueAsDouble

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

Parameters:
lPropertyID - property id
Returns:
override value as double

GetOverrideValueAsByte

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

Parameters:
lPropertyID - property id
Returns:
override value as byte

GetOverrideValueAsObject

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

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

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

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

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

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

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

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

boolean GetFullTextIndex()
Returns if this document type has full text index

Returns:
true/false

SetFullTextIndex

void SetFullTextIndex(boolean Value)
Sets the document type to have full text indexing

Parameters:
bFullTextIndex - true/false

GetRequiredPropertyIDs

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


SetRequiredPropertyIDs

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

int GetApprovalSettings()
Returns the approval settings

Returns:
int

SetApprovalSettings

void SetApprovalSettings(int Value)
Sets the approval settings

Parameters:
lApprovalSettings - new approval settings

GetCommonFields

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

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

Returns:
String of image uuid


Copyright 2008 Plumtree Software Inc. All Rights Reserved.