com.plumtree.server
Interface IPTUserInterface

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

public interface IPTUserInterface
extends IPTObject

Represents a type of user interface that a portlet or other web service may optionally support, such as wireless device portals.

Author:
JosephS
See Also:
IPTWebService

Method Summary
 java.lang.String GetDTDURL()
          For UIs that are written in XML, this provides a DTD we can check against.
 java.lang.Object[] GetMIMETypes()
          Allows the web service to do rudimentary checking of the content returned by a server.
 java.lang.String GetUniqueID()
          This gets the unique user interface ID.
 java.lang.String GetURL()
          Allows us to redirect to the UI based on what type of device is accessing the portal.
 void SetDTDURL(java.lang.String Value)
          For UIs that are written in XML, this provides a DTD we can check against.
 void SetMIMETypes(java.lang.Object[] Value)
          Deprecated.  
 void SetMIMETypes(java.lang.String[] Value)
          Allows the web service to do rudimentary checking of the content returned by a server.
 void SetUniqueID(java.lang.String Value)
          This sets the unique user interface ID.
 void SetURL(java.lang.String Value)
          Allows us to redirect to the UI based on what type of device is accessing the portal.
 
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

GetUniqueID

java.lang.String GetUniqueID()
This gets the unique user interface ID.

Returns:
a unique identifier, usually a URI

SetUniqueID

void SetUniqueID(java.lang.String Value)
This sets the unique user interface ID.

Parameters:
Value - a unique identifier, usually a URI

GetURL

java.lang.String GetURL()
Allows us to redirect to the UI based on what type of device is accessing the portal.

Returns:
the URL of the start page of the UI

SetURL

void SetURL(java.lang.String Value)
Allows us to redirect to the UI based on what type of device is accessing the portal.

Parameters:
Value - the URL of the start page of the UI

GetMIMETypes

java.lang.Object[] GetMIMETypes()
Allows the web service to do rudimentary checking of the content returned by a server.

Returns:
legal MIME types in this user interface

SetMIMETypes

void SetMIMETypes(java.lang.String[] Value)
Allows the web service to do rudimentary checking of the content returned by a server.

Parameters:
Value - legal MIME types in this user interface

SetMIMETypes

void SetMIMETypes(java.lang.Object[] Value)
Deprecated. 


GetDTDURL

java.lang.String GetDTDURL()
For UIs that are written in XML, this provides a DTD we can check against.

Returns:
URL to a DTD file

SetDTDURL

void SetDTDURL(java.lang.String Value)
For UIs that are written in XML, this provides a DTD we can check against.

Parameters:
Value - URL to a DTD file


Copyright 2008 Plumtree Software Inc. All Rights Reserved.