com.plumtree.server
Interface IPTObject

All Superinterfaces:

IPTLocalizable, IPTServerContext, IPTStorable, IPTUnknown

All Known Subinterfaces:

IPTAdminFolder, IPTAuthSource, IPTCard, IPTCommunity, IPTCommunityTemplate, IPTCrawler, IPTDataSource, IPTDocumentType, IPTExpression, IPTExternalOperation, IPTFederatedPortal, IPTFilter, IPTFolder, IPTGadget, IPTGadgetBundle, IPTGadgetContentServer, IPTGadgetTemplate, IPTGuestLogin, IPTInvitation, IPTJob, IPTMyPages, IPTPage, IPTPageContainer, IPTPageTemplate, IPTPreferencesContext, IPTProfilePage, IPTProfileSection, IPTProfileSource, IPTProperty, IPTSavedSearch, IPTSiteMapFolder, IPTSubPortal, IPTTaxonomist, IPTUser, IPTUserGroup, IPTUserInterface, IPTWebService

public interface IPTObject
extends IPTLocalizable, IPTServerContext

This is the fundamental interface for all Plumtree administrative objects. It defines base object functionality, such as class type, Last Modified dates, etc.

Author:

michaels

See Also:

IPTLocalizable

Method Summary

int	GetAdminFolderID() Returns the ID of the Admin Folder into which this object is stored
int	GetClassID() Returns the ID of the class to which this object belongs (from PT_CLASSIDS)
com.plumtree.openfoundation.util.XPDateTime	GetCreated() Returns the DateTime at which this object was created.
java.lang.String	GetImageUUID() Returns the UUID for the image for this object.
com.plumtree.openfoundation.util.XPDateTime	GetLastModified() Returns the DateTime at which this object was last modified.
IPTObjectProperties	GetObjectProperties() Object Properties are used to associated extended Properties with Objects in a uniform way.
void	SetAdminFolderID(int Value) Set the Admin Folder into which this object should be stored
void	SetImageUUID(java.lang.String Value) Sets the UUID for the image for this object.
void	SetLastModified(com.plumtree.openfoundation.util.XPDateTime Value) Sets the DateTime at which this object was last modified.

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

GetClassID

int GetClassID()

Returns the ID of the class to which this object belongs (from PT_CLASSIDS)

Returns:

the Class ID

See Also:

PT_CLASSIDS

GetLastModified

com.plumtree.openfoundation.util.XPDateTime GetLastModified()

Returns the DateTime at which this object was last modified.

Returns:

last modified date

SetLastModified

void SetLastModified(com.plumtree.openfoundation.util.XPDateTime Value)

Sets the DateTime at which this object was last modified. This function should NOT be called by most clients, as objects automatically adjust their Last Modified time as they are modified.

Parameters:

Value - last modified date

GetCreated

com.plumtree.openfoundation.util.XPDateTime GetCreated()

Returns the DateTime at which this object was created.

Returns:

Value created date

GetImageUUID

java.lang.String GetImageUUID()

Returns the UUID for the image for this object. This is used by the UI to identify which image to use to represent the object.

Returns:

the image UUID as a string

SetImageUUID

void SetImageUUID(java.lang.String Value)

Sets the UUID for the image for this object.

Parameters:

Value - the image UUID as a string

GetAdminFolderID

int GetAdminFolderID()

Returns the ID of the Admin Folder into which this object is stored

Returns:

Admin Folder ID

See Also:

IPTAdminFolder

SetAdminFolderID

void SetAdminFolderID(int Value)

Set the Admin Folder into which this object should be stored

Parameters:

Value - the ID of the Admin Folder

GetObjectProperties

IPTObjectProperties GetObjectProperties()

Object Properties are used to associated extended Properties with Objects in a uniform way. Use this call to retrieve the IPTObjectProperties interface for this object.

Returns:

the IPTObjectProperties interface

See Also:

IPTObjectProperties