com.centrasite.control
Interface ReportInterface

All Known Implementing Classes:
AbstractReport, AssetReport, AssociationReport, AssociationsTab.AssociationsReport, AuditableEventReport, ChildOrganizationReport, ChildOrganizationTab.RegistryObjectChildOrganizationReport, ClassificationReport, ClassificationSchemeReport, ClassificationTab.RegistryObjectClassificationReport, ConceptReport, ConsumersTab.ConsumerApplicationsReport, ConsumersTab.UsersGroupsReport, CPAReport, CPPReport, ExternalIdentifierReport, ExternalLinkReport, ExternalLinksTab.RegistryObjectExternalLinkReport, ExternalLinksTab.RepositoryNodeExternalLinkReport, ExtrinsicObjectReport, FileDetailGeneralReport, FileDetailHistoryReport, FileDetailSecurityReport, FolderDetailGeneralReport, HistoryDetailGeneralReport, ListReport, LogReport, MyNotificationsReport, NotificationSettings, OperationReport, OrganizationReport, PackageReport, PackageResourcesReport, ProcessReport, RegistryEntryReport, RegistryObjectAuditableEventReport, RegistryObjectReport, ReportReport, RepositoryOverviewReport, ServiceBindingReport, ServiceBindingTab.ServiceBindingReportReport, ServiceReport, ServiceTab.OrganizationServiceReport, ShowTraceCommand.TraceReport, SpecificationLinkReport, SpecificationLinksTab.SpecificationLinksOfServiceBindingReport, TextualImpactAnalysisReport, UserReport, VersionsReport, VersionsTab.CustomVersionsReport, WSDLReport

public interface ReportInterface

Definition of of report interface.


Field Summary
static int ASCENDING
          Sort ASCENDING
static int DESCENDING
          Sort DESCENDING
static int FLAG_ADD_CONTEXT_MENU_METHOD
          The accessor value will support showing context menu.
static int FLAG_NONE
          default: column is rendered part of a CSVColumn and can be hidden dynamically
static int FLAG_NOT_PART_OF_COLUMNS
          the accessor will not be rendered as a column is not part of CSVColumn and thus always visible
static int FLAG_NOT_PART_OF_CSVCOLUMN
          column is not part of CSVColumn and thus always visible
static int FLAG_NOT_PART_OF_LINES
          the accessor value will not be rendered in the report content but its column will
static int FLAG_RENDER_ITEM_IMAGE
          The item's image (Item.getImageUrl()) will be added in addition to the accessor value.
static int FLAG_RENDER_READ_ONLY
          display read only
static int FLAG_RENDER_REFERENCE_ITEM_IMAGE
           
static int FLAG_RENDER_VALUE_AS_CHECKBOX
          The accessor value will be rendered as checkbox.
static int FLAG_RENDER_VALUE_AS_IMAGEPROP
          the accessor will associated with the image prop of the line
static int FLAG_RENDER_VALUE_WITH_METHODLINK
          The accessor value will be rendered as methodlink.
static int FLAG_SORT_BY_DEFAULT_ASC
          sort by default ascending
static int FLAG_SORT_BY_DEFAULT_DESC
          sort by default descending
static int FLAG_SORT_ICON_INVISIBLE
          display sort icon
static int FLAG_VISIBLE_ALWAYS
          column must always be visible, is part of CSVColumn
static int FLAG_VISIBLE_BY_DEFAULT
          column is rendered part of a CSVColumn and is visible by default
 
Method Summary
 boolean appendUserHeading(java.lang.String heading)
          Append a user heading element for this report NOTE: If a heading is set, then only these headings will be given back on the next execute.
 void endProcess()
          Notify that processing of this report has finished
 void execute()
          Compute the report.
 java.util.HashMap getAccessor()
          Get hashmap containing accessors for all headings
 java.util.List getAllHeadings()
          Get all the heading that can be displayed in a table for this type
 java.util.List getAllHeadingsNotPartOfColumn()
          Get all line properties that are not displayed as column (eg description)
 java.util.List getCommands()
          Get set of commands to be rendered (for example in a toolbar) for this report.
 java.util.List getContextMenuCommands(Item item)
          Obtain the commands list to be displayed on context menu request.
 java.lang.String getDescription(java.util.Locale locale)
          Get description of report
 java.util.List getFixedColumnHeadings()
          Get the list of headers/columns for this report which shall always be visible
 java.util.List getHeadings()
          Get the list of visible headers/columns for this report
 java.util.List getHeadingsNotPartOfColumn()
          Get all line properties that are not displayed as column (eg description)
 java.lang.String getId()
          Get id for type of report
 java.lang.String getImageURL()
          Get URL of icon
 Item getItem()
          Get the Item this report is based on
 java.lang.String getNonEmptyTitle()
           
 com.softwareag.cis.plugin.command.Command getOnSelectCommand(Item item)
          Obtain the command to be executed when selecting a row in the report
 PropertyAccessor getPropertyAccessor(java.lang.String internalName)
          Get PropertyAccessor for given internal name of heading
 RowIterator getRows()
          Get the rows of the report
 java.lang.String getTitle(java.util.Locale locale)
          Get title of report
 java.util.List getToolbarCommands()
          Obtain the commands list to be displayed within the report toolbar.
 boolean hasPropertyAccessorWithFlag(java.lang.String internalName, int flags)
          Check whether given flags are set for PropertyAccessor
 boolean hasUserConfiguration()
          Method can be used to determine if for current user a configuration exist.
 boolean implicitlyAddRefreshCommand()
          Check whether the standard "Refresh" command shall implicitly be added to this report's toolbar
 boolean implicitlyAddSaveReportCommand()
          Check whether the standard "Save Report" command shall implicitly be added to this report's toolbar.
 boolean implicitlyAddSelectColumnsCommand()
          Check whether the standard "Select Columns" command shall implicitly be added to this report's toolbar
 void initializeUserHeadings(Connector con)
          Initialize the user selected headings.
 void initializeUserHeadings(GUIConfigurationExt config, java.lang.String user, java.lang.String password)
          Initialize the user selected headings.
 void removeCommand(java.lang.Class commandClass)
          Remove command corresponding to given class from set of commands
 void resetUserHeadings()
          Reset the current user heading - that way you can add new ones using setUserHeading()
 void setItem(Item item)
          Set the Item to get the report on
 void setItemsProvider(ItemsProvider itemProvider)
          Set data source providing set of items to be rendered
 java.lang.String toXhtml()
          Transform the report to XHTML.
 java.lang.String toXhtml(Connector connector)
          Transform the report to XHTML.
 

Field Detail

FLAG_NONE

static final int FLAG_NONE
default: column is rendered part of a CSVColumn and can be hidden dynamically

See Also:
Constant Field Values

FLAG_VISIBLE_BY_DEFAULT

static final int FLAG_VISIBLE_BY_DEFAULT
column is rendered part of a CSVColumn and is visible by default

See Also:
Constant Field Values

FLAG_VISIBLE_ALWAYS

static final int FLAG_VISIBLE_ALWAYS
column must always be visible, is part of CSVColumn

See Also:
Constant Field Values

FLAG_NOT_PART_OF_CSVCOLUMN

static final int FLAG_NOT_PART_OF_CSVCOLUMN
column is not part of CSVColumn and thus always visible

See Also:
Constant Field Values

FLAG_NOT_PART_OF_COLUMNS

static final int FLAG_NOT_PART_OF_COLUMNS
the accessor will not be rendered as a column is not part of CSVColumn and thus always visible

See Also:
Constant Field Values

FLAG_RENDER_VALUE_WITH_METHODLINK

static final int FLAG_RENDER_VALUE_WITH_METHODLINK
The accessor value will be rendered as methodlink. The executed method name will be "on" + PropertyAccessor.getPropertyName() + "Click".

See Also:
Constant Field Values

FLAG_ADD_CONTEXT_MENU_METHOD

static final int FLAG_ADD_CONTEXT_MENU_METHOD
The accessor value will support showing context menu. When context menu requested, the executed method will be "on" + PropertyAccessor.getPropertyName() + "ContextMenu". This flag works only together with FLAG_RENDER_VALUE_WITH_METHODLINK.

See Also:
Constant Field Values

FLAG_NOT_PART_OF_LINES

static final int FLAG_NOT_PART_OF_LINES
the accessor value will not be rendered in the report content but its column will

See Also:
Constant Field Values

FLAG_RENDER_VALUE_AS_IMAGEPROP

static final int FLAG_RENDER_VALUE_AS_IMAGEPROP
the accessor will associated with the image prop of the line

See Also:
Constant Field Values

FLAG_SORT_BY_DEFAULT_ASC

static final int FLAG_SORT_BY_DEFAULT_ASC
sort by default ascending

See Also:
Constant Field Values

FLAG_SORT_BY_DEFAULT_DESC

static final int FLAG_SORT_BY_DEFAULT_DESC
sort by default descending

See Also:
Constant Field Values

FLAG_SORT_ICON_INVISIBLE

static final int FLAG_SORT_ICON_INVISIBLE
display sort icon

See Also:
Constant Field Values

FLAG_RENDER_READ_ONLY

static final int FLAG_RENDER_READ_ONLY
display read only

See Also:
Constant Field Values

FLAG_RENDER_VALUE_AS_CHECKBOX

static final int FLAG_RENDER_VALUE_AS_CHECKBOX
The accessor value will be rendered as checkbox.

See Also:
Constant Field Values

FLAG_RENDER_ITEM_IMAGE

static final int FLAG_RENDER_ITEM_IMAGE
The item's image (Item.getImageUrl()) will be added in addition to the accessor value. This is different from FLAG_RENDER_VALUE_AS_IMAGEPROP where only image is rendered and the accessor value is taken as the image url. Used only with textgrid.

See Also:
Constant Field Values

FLAG_RENDER_REFERENCE_ITEM_IMAGE

static final int FLAG_RENDER_REFERENCE_ITEM_IMAGE
See Also:
Constant Field Values

DESCENDING

static final int DESCENDING
Sort DESCENDING

See Also:
Constant Field Values

ASCENDING

static final int ASCENDING
Sort ASCENDING

See Also:
Constant Field Values
Method Detail

getId

java.lang.String getId()
Get id for type of report

Returns:
the id

getItem

Item getItem()
Get the Item this report is based on


setItem

void setItem(Item item)
Set the Item to get the report on


getTitle

java.lang.String getTitle(java.util.Locale locale)
                          throws java.lang.Exception
Get title of report

Throws:
java.lang.Exception

getDescription

java.lang.String getDescription(java.util.Locale locale)
                                throws java.lang.Exception
Get description of report

Throws:
java.lang.Exception

getImageURL

java.lang.String getImageURL()
                             throws java.lang.Exception
Get URL of icon

Returns:
null if no image available
Throws:
java.lang.Exception

getCommands

java.util.List getCommands()
Get set of commands to be rendered (for example in a toolbar) for this report.

Returns:
List of commands or null if none.

removeCommand

void removeCommand(java.lang.Class commandClass)
Remove command corresponding to given class from set of commands

Parameters:
commandClass - class of command to be removed

implicitlyAddRefreshCommand

boolean implicitlyAddRefreshCommand()
Check whether the standard "Refresh" command shall implicitly be added to this report's toolbar

Returns:
true if to be added, false otherwise

implicitlyAddSelectColumnsCommand

boolean implicitlyAddSelectColumnsCommand()
Check whether the standard "Select Columns" command shall implicitly be added to this report's toolbar

Returns:
true if to be added, false otherwise

implicitlyAddSaveReportCommand

boolean implicitlyAddSaveReportCommand()
Check whether the standard "Save Report" command shall implicitly be added to this report's toolbar. Default implementation returns true.

Returns:
true if to be added, false otherwise

getAccessor

java.util.HashMap getAccessor()
Get hashmap containing accessors for all headings

Returns:
accessors hashmap

getPropertyAccessor

PropertyAccessor getPropertyAccessor(java.lang.String internalName)
Get PropertyAccessor for given internal name of heading

Parameters:
internalName - internal name of heading
Returns:
the PropertyAccessor or null if not found

hasPropertyAccessorWithFlag

boolean hasPropertyAccessorWithFlag(java.lang.String internalName,
                                    int flags)
Check whether given flags are set for PropertyAccessor

Parameters:
internalName - internal name of PropertyAccessor
flags - flags to be tested whether set for PropertyAccessor
Returns:
true if respective flags are set
Throws:
java.lang.NullPointerException - if invalid propertyName specified

getHeadings

java.util.List getHeadings()
Get the list of visible headers/columns for this report

Returns:
Collection of the headings for this report

getFixedColumnHeadings

java.util.List getFixedColumnHeadings()
Get the list of headers/columns for this report which shall always be visible

Returns:
Collection of the headings for this report

getAllHeadings

java.util.List getAllHeadings()
Get all the heading that can be displayed in a table for this type

Returns:
map of internal name to external name

getAllHeadingsNotPartOfColumn

java.util.List getAllHeadingsNotPartOfColumn()
Get all line properties that are not displayed as column (eg description)

Returns:
map of internal name to external name

getHeadingsNotPartOfColumn

java.util.List getHeadingsNotPartOfColumn()
Get all line properties that are not displayed as column (eg description)

Returns:
map of internal name to external name

resetUserHeadings

void resetUserHeadings()
Reset the current user heading - that way you can add new ones using setUserHeading()

See Also:
appendUserHeading(String)

appendUserHeading

boolean appendUserHeading(java.lang.String heading)
Append a user heading element for this report NOTE: If a heading is set, then only these headings will be given back on the next execute.

Parameters:
heading - heading name
Returns:
true if heading was not yet in list of user configured headings/columns

initializeUserHeadings

void initializeUserHeadings(Connector con)
Initialize the user selected headings.

Parameters:
con - the Connector allowing access to the user settings

initializeUserHeadings

void initializeUserHeadings(GUIConfigurationExt config,
                            java.lang.String user,
                            java.lang.String password)
Initialize the user selected headings.

Parameters:
config - user configuration
user - user name used to obtained selected headings.
password - user password

getRows

RowIterator getRows()
Get the rows of the report

Returns:
iterator over the rows of the report

execute

void execute()
             throws java.lang.Exception
Compute the report. NOTE: This must be called before getting any rows/headings. This must also be called after changing filter/sort conditions.

Throws:
java.lang.Exception

toXhtml

java.lang.String toXhtml()
Transform the report to XHTML.


toXhtml

java.lang.String toXhtml(Connector connector)
Transform the report to XHTML.


getNonEmptyTitle

java.lang.String getNonEmptyTitle()

getOnSelectCommand

com.softwareag.cis.plugin.command.Command getOnSelectCommand(Item item)
Obtain the command to be executed when selecting a row in the report

Parameters:
item -
Returns:
the command to be executed; null if no command to be executed

getContextMenuCommands

java.util.List getContextMenuCommands(Item item)
Obtain the commands list to be displayed on context menu request.

Parameters:
item -
Returns:
The commands list.

getToolbarCommands

java.util.List getToolbarCommands()
Obtain the commands list to be displayed within the report toolbar.

Returns:
The commands list.

setItemsProvider

void setItemsProvider(ItemsProvider itemProvider)
Set data source providing set of items to be rendered

Parameters:
itemProvider -

endProcess

void endProcess()
Notify that processing of this report has finished


hasUserConfiguration

boolean hasUserConfiguration()
Method can be used to determine if for current user a configuration exist. If not the default accessors are applied.

Returns:
true if user configuration exists otherwise false