com.plumtree.server
Interface IPTObject

All Superinterfaces:
IPTLocalizable, IPTUnknown
All Known Subinterfaces:
IPTAdminFolder, IPTAuthSource, IPTCard, IPTCommunity, IPTCommunityTemplate, IPTCrawler, IPTDataSource, IPTDocumentType, IPTExternalOperation, IPTFederatedPortal, IPTFilter, IPTFolder, IPTGadget, IPTGadgetBundle, IPTGadgetContentServer, IPTGadgetTemplate, IPTInvitation, IPTJob, IPTPageTemplate, IPTProfilePage, IPTProfileSection, IPTProfileSource, IPTProperty, IPTSavedSearch, IPTSiteMapFolder, IPTSubPortal, IPTTaxonomist, IPTUser, IPTUserGroup, IPTUserInterface, IPTWebService

public interface IPTObject
extends IPTLocalizable

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

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
 

Method Detail

GetClassID

public 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

public com.plumtree.openfoundation.util.XPDateTime GetLastModified()
Returns the DateTime at which this object was last modified
Returns:
last modified date

SetLastModified

public 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:
last - modified date

GetCreated

public com.plumtree.openfoundation.util.XPDateTime GetCreated()
Returns the DateTime at which this object was created
Returns:
created date

GetImageUUID

public 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

public void SetImageUUID(java.lang.String Value)
Sets the UUID for the image for this object.
Parameters:
Value - the image UUID as a string

GetAdminFolderID

public int GetAdminFolderID()
Returns the ID of the Admin Folder into which this object is stored
Returns:
Admin Folder ID
See Also:
IPTAdminFolder

SetAdminFolderID

public void SetAdminFolderID(int Value)
Set the Admin Folder into which this object should be stored
Parameters:
Value - the ID of the Admin Folder

GetObjectProperties

public 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


Copyright © 2003 Plumtree Software Inc. All Rights Reserved.