com.plumtree.server
Interface IPTGadgetCacheSite

All Superinterfaces:
IPTUnknown

public interface IPTGadgetCacheSite
extends IPTUnknown

Object used to hold gadget data in the gadget cache. Wraps the disabled and normal gadget cache entries into a single manageable entry.

Version:
5.0
Author:
DavidP
See Also:
IPTGadget

Method Summary
 java.lang.String GetDisabledMessage()
          Returns message to display in gadget if disabled.
 boolean GetEnabled()
          Returns boolean enabled flag for this gadget
 java.lang.Object GetGadget()
          Instance of IPTGadget referencing the gadget in this gadget cache entry
 int GetGadgetID()
          ID of gadget in this entry in the gadget cache.
 com.plumtree.openfoundation.util.XPDateTime GetGadgetLastModified()
          Returns the XPDateTime which is the last modified date/time for the portlet.
 java.lang.String GetGadgetUUID()
          Returns the String which is the UUID for the portlet.
 int GetSupportsPersonalization()
          Returns int for personalization level.
 java.lang.Object GetWebService()
          Returns the integer ID of the web service associated with this gadget instance.
 
Methods inherited from interface com.plumtree.server.IPTUnknown
GetInterfaces
 

Method Detail

GetGadgetID

int GetGadgetID()
ID of gadget in this entry in the gadget cache.

Returns:
int

GetGadget

java.lang.Object GetGadget()
Instance of IPTGadget referencing the gadget in this gadget cache entry

Returns:
Object castable to IPTGadget

GetEnabled

boolean GetEnabled()
Returns boolean enabled flag for this gadget

Returns:
boolean true if enabled

GetDisabledMessage

java.lang.String GetDisabledMessage()
Returns message to display in gadget if disabled.

Returns:
String

GetSupportsPersonalization

int GetSupportsPersonalization()
Returns int for personalization level. This is an assembly of bitflags signifying the level of personalization. An example would be the bitflag PT_GADGETPERSONALIZATION_HELPPAGE.

Returns:
int
See Also:
PT_GADGETPERSONALIZATION_ROLES

GetWebService

java.lang.Object GetWebService()
Returns the integer ID of the web service associated with this gadget instance.

Returns:
int web service ID

GetGadgetUUID

java.lang.String GetGadgetUUID()
Returns the String which is the UUID for the portlet.

Returns:
String UUID

GetGadgetLastModified

com.plumtree.openfoundation.util.XPDateTime GetGadgetLastModified()
Returns the XPDateTime which is the last modified date/time for the portlet.

Returns:
XPDateTime


Copyright 2008 Plumtree Software Inc. All Rights Reserved.