com.sage.orion.sdata.servlet.accpac
Class PortalPortlet

java.lang.Object
  extended by com.sage.orion.sdata.servlet.accpac.PortalPortlet

public class PortalPortlet
extends java.lang.Object

The portlet model that is supposed to be consumed by the portal module.


Nested Class Summary
static class PortalPortlet.ContentType
          The content type of the portlet.
 
Field Summary
static java.lang.String CONTENT_TYPE_DECLARATIVE_PORTLET
           
static java.lang.String CONTENT_TYPE_LEGACY_UI
           
static java.lang.String CONTENT_TYPE_URL_PORTLET
           
 
Constructor Summary
PortalPortlet(java.lang.String appID, java.lang.String appVersion, com.sage.orion.sdata.servlet.accpac.Portlet portlet)
          Constructor.
 
Method Summary
 java.lang.String getAppID()
          Gets the application ID.
 java.lang.String getApplicationURL()
          Gets the application URL.
 java.lang.String getAppVersion()
          Gets the application version.
 java.lang.String getCaptionID()
          Gets the caption ID.
 java.lang.String getCaptionString()
          Gets the caption String.
 java.lang.String getCategoryID()
          Gets the category ID.
 PortalPortlet.ContentType getContentType()
          Gets the content type.
 java.lang.String getContentTypeString()
          Gets the content type as a String.
 java.lang.String getHelpID()
          Gets the help ID.
 java.lang.String getID()
          Gets the ID for the portlet.
 java.lang.String getLegacyClsID()
          Gets the legacy clause ID.
 java.lang.String getLegacyFileName()
          Gets the legacy file name.
 java.lang.String getLegacyObjectID()
          Gets the legacy object ID.
 java.lang.String getPreviewID()
          Gets the preview ID.
 java.lang.String getPreviewImage()
          Gets the preview image url.
 java.lang.String getPreviewString()
          Gets the preview String.
 java.lang.String getReportName()
          Gets the report name.
 java.lang.String getShortCategoryID()
          Gets the short category ID.
 java.lang.String getShortCategoryString()
          Gets the short category String.
 java.lang.String getShowConfigureMenu()
          Gets the value for whether or not to show the configure menu.
 java.lang.String getShowRefreshMenu()
          Gets the value for whether or not to show the refresh menu.
 java.lang.String getShowReportMenu()
          Gets the value for whether or not to show the report menu.
 java.lang.String getThumbnailImage()
          Gets the thumbnail image url.
 java.lang.String getType()
          Gets the portlet type.
 java.lang.String getUiDefCategory()
          Gets the UI definition category.
 java.lang.String getUiDefName()
          Gets the UI definition name.
 java.lang.String getUiDefVersion()
          Gets the UI definition version.
 void setCaptionString(java.lang.String captionString)
          Sets the caption String
 void setPreviewString(java.lang.String previewString)
          Sets the preview String.
 void setShortCategoryID(java.lang.String shortCategoryID)
          Sets the short category ID.
 void setShortCategoryString(java.lang.String shortCategoryString)
          Sets the short category string.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CONTENT_TYPE_URL_PORTLET

public static final java.lang.String CONTENT_TYPE_URL_PORTLET
See Also:
Constant Field Values

CONTENT_TYPE_DECLARATIVE_PORTLET

public static final java.lang.String CONTENT_TYPE_DECLARATIVE_PORTLET
See Also:
Constant Field Values

CONTENT_TYPE_LEGACY_UI

public static final java.lang.String CONTENT_TYPE_LEGACY_UI
See Also:
Constant Field Values
Constructor Detail

PortalPortlet

public PortalPortlet(java.lang.String appID,
                     java.lang.String appVersion,
                     com.sage.orion.sdata.servlet.accpac.Portlet portlet)
Constructor.

Parameters:
appID - Application ID.
appVersion - Application version.
portlet - The Portlet object.
Method Detail

getAppID

public java.lang.String getAppID()
Gets the application ID.

Returns:
The application ID.

getAppVersion

public java.lang.String getAppVersion()
Gets the application version.

Returns:
The application version.

getID

public java.lang.String getID()
Gets the ID for the portlet.

Returns:
The portlet ID.

getCategoryID

public java.lang.String getCategoryID()
Gets the category ID.

Returns:
The category ID.

getType

public java.lang.String getType()
Gets the portlet type.

Returns:
The portlet type.

getContentType

public PortalPortlet.ContentType getContentType()
Gets the content type.

Returns:
The content type.

getContentTypeString

public java.lang.String getContentTypeString()
Gets the content type as a String.

Returns:
The content type as a String.

getApplicationURL

public java.lang.String getApplicationURL()
Gets the application URL.

Returns:
The application URL.

getCaptionID

public java.lang.String getCaptionID()
Gets the caption ID.

Returns:
The caption ID.

getPreviewID

public java.lang.String getPreviewID()
Gets the preview ID.

Returns:
The preview ID.

getPreviewImage

public java.lang.String getPreviewImage()
Gets the preview image url.

Returns:
The preview image url.

getThumbnailImage

public java.lang.String getThumbnailImage()
Gets the thumbnail image url.

Returns:
The thumbnail image url.

getHelpID

public java.lang.String getHelpID()
Gets the help ID.

Returns:
The help ID.

getShowConfigureMenu

public java.lang.String getShowConfigureMenu()
Gets the value for whether or not to show the configure menu.

Returns:
The value for whether or not to show the configure menu.

getShowReportMenu

public java.lang.String getShowReportMenu()
Gets the value for whether or not to show the report menu.

Returns:
The value for whether or not to show the report menu.

getShowRefreshMenu

public java.lang.String getShowRefreshMenu()
Gets the value for whether or not to show the refresh menu.

Returns:
The value for whether or not to show the refresh menu.

getUiDefCategory

public java.lang.String getUiDefCategory()
Gets the UI definition category.

Returns:
The UI definition category.

getUiDefName

public java.lang.String getUiDefName()
Gets the UI definition name.

Returns:
The UI definition name.

getLegacyObjectID

public java.lang.String getLegacyObjectID()
Gets the legacy object ID.

Returns:
The legacy object ID.

getLegacyFileName

public java.lang.String getLegacyFileName()
Gets the legacy file name.

Returns:
The legacy file name.

getLegacyClsID

public java.lang.String getLegacyClsID()
Gets the legacy clause ID.

Returns:
The legacy clause ID.

getUiDefVersion

public java.lang.String getUiDefVersion()
Gets the UI definition version.

Returns:
The UI definition version.

getCaptionString

public java.lang.String getCaptionString()
Gets the caption String.

Returns:
The caption String.

setCaptionString

public void setCaptionString(java.lang.String captionString)
Sets the caption String

Parameters:
captionString - The caption String.

getPreviewString

public java.lang.String getPreviewString()
Gets the preview String.

Returns:
The preview String.

setPreviewString

public void setPreviewString(java.lang.String previewString)
Sets the preview String.

Parameters:
previewString - The preview String.

getShortCategoryID

public java.lang.String getShortCategoryID()
Gets the short category ID.

Returns:
The short category ID.

setShortCategoryID

public void setShortCategoryID(java.lang.String shortCategoryID)
Sets the short category ID.

Parameters:
shortCategoryID - The short category ID.

getShortCategoryString

public java.lang.String getShortCategoryString()
Gets the short category String.

Returns:
The short category String.

setShortCategoryString

public void setShortCategoryString(java.lang.String shortCategoryString)
Sets the short category string.

Parameters:
shortCategoryString - The short category string.

getReportName

public java.lang.String getReportName()
Gets the report name.

Returns:
the report name or an empty string if the report name is null.


Copyright © 2011 Sage Software, Inc. All rights reserved.