com.technia.tvc.office.server.fpd

Interface HandlerCtx

public interface HandlerCtx

Since:

6.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	HandlerCtx.PackageDependency Represents a dependency, which the generated package is dependent upon.
static interface	HandlerCtx.PackageEntry Represents an entry in the generated package.
static interface	HandlerCtx.TableExportEntry This is an extended package entry, which represents a table export.
static interface	HandlerCtx.XMLWriterEntry

Method Summary

Modifier and Type	Method and Description
HandlerCtx.PackageEntry	add(java.io.InputStream in) Adds an arbitrary InputStream to the package.
HandlerCtx.PackageEntry	add(java.io.Reader reader) Adds an arbitrary Reader to the package.
HandlerCtx.PackageEntry	add(java.lang.String data) Adds an arbitrary string to the package.
HandlerCtx.PackageEntry	addDataProvider(DataProvider dataProvider) Adds an arbitrary data provider to the package
HandlerCtx.TableExportEntry	addExpandedData(java.lang.String[] rootObjectIds, java.lang.String roleName, java.lang.String[] filterNames, int expandLevels, java.lang.String tableName) Adds the output from a structure expansion
HandlerCtx.TableExportEntry	addExpandedData(java.lang.String rootObjectId, java.lang.String roleName, java.lang.String[] filterNames, int expandLevels, java.lang.String tableName) Adds the output from a structure expansion
HandlerCtx.PackageEntry	addExportBus(java.lang.String typePattern, java.lang.String namePattern, java.lang.String revPattern) Adds the result of a export businessobject output
HandlerCtx.PackageEntry	addExportBus(java.lang.String typePattern, java.lang.String namePattern, java.lang.String revPattern, boolean files, boolean captured, boolean icons, boolean history, boolean fromRelationships, boolean toRelationships, boolean states, boolean archive, javax.xml.transform.Source xslt, java.util.Map<java.lang.String,java.lang.String> parameters) Adds the result of a export business object output transformed via the provided XSLT stylesheet.
HandlerCtx.PackageEntry	addExportBus(java.lang.String typePattern, java.lang.String namePattern, java.lang.String revPattern, javax.xml.transform.Source xslt, java.util.Map<java.lang.String,java.lang.String> parameters) Adds the result of a export businessobject output transformed via the provided XSLT stylesheet.
HandlerCtx.PackageEntry	addFile(java.lang.String objectId, java.lang.String format, java.lang.String fileName) Adds a file from a businessobject to the package.
HandlerCtx.PackageEntry	addFile(java.lang.String type, java.lang.String name, java.lang.String revision, java.lang.String format, java.lang.String fileName) Adds a file from a businessobject to the package.
HandlerCtx.PackageEntry	addFile(java.lang.String type, java.lang.String name, java.lang.String revision, java.lang.String vault, java.lang.String format, java.lang.String fileName) Adds a file from a businessobject to the package.
HandlerCtx.PackageDependency	addFileDependency(java.lang.String objectId, java.lang.String format, java.lang.String fileName) Adds a file dependency
HandlerCtx.PackageDependency	addFileDependency(java.lang.String type, java.lang.String name, java.lang.String revision, java.lang.String format, java.lang.String fileName) Adds a file dependency
HandlerCtx.PackageDependency	addFileDependency(java.lang.String type, java.lang.String name, java.lang.String revision, java.lang.String vault, java.lang.String format, java.lang.String fileName) Adds a file dependency
HandlerCtx.PackageEntry	addJPO(java.lang.String jpo, java.lang.String function) Adds the output from a JPO execution.
HandlerCtx.PackageEntry	addJPO(java.lang.String jpo, java.lang.String function, java.io.Serializable argument) Adds the output from a JPO execution.
HandlerCtx.PackageEntry	addMQL(java.lang.String mqlCommand) Adds the output from a MQL command execution.
HandlerCtx.PackageEntry	addMQL(java.lang.String mqlCommand, boolean parseMacros) Adds mql code, and parses the mql code and resolves any macros before the command is executed.
HandlerCtx.PackageEntry	addMQL(java.lang.String mqlCommand, java.util.Map<java.lang.String,java.lang.String> macros) Adds mql code, and parses the mql code and resolves the macros within the provided map (if available), before the command is executed.
HandlerCtx.PackageEntry	addPageContent(java.lang.String pageName) Adds the content of a page object as resource
void	addReleasableResource(com.technia.tvc.office.server.fpd.ReleasableResource rr) Adds something needed to be released at the same time as the package is released.
HandlerCtx.TableExportEntry	addTable(TableBean<? extends TableData> table) Adds a custom table bean to the package.
HandlerCtx.TableExportEntry	addTableData(java.lang.String inquiryName, java.util.Map<java.lang.String,java.lang.String> args, java.lang.String tableName) Adds the objects returned by the specified inquiry, evaluated with the specified table.
HandlerCtx.TableExportEntry	addTableData(java.lang.String dataSet, java.lang.String tableName)
HandlerCtx.TableExportEntry	addTableData(java.lang.String jpoName, java.lang.String function, java.util.Map<java.lang.String,java.lang.String> args, java.lang.String tableName) Adds the objects returned by the specified JPO, evaluated with the specified table.
HandlerCtx.TableExportEntry	addTableData(java.lang.String typePattern, java.lang.String namePattern, java.lang.String revPattern, java.lang.String ownerPattern, java.lang.String vaultPattern, java.lang.String whereClause, int limit, boolean expandType, java.lang.String tableName) Adds the objects returned by the query arguments, evaluated with the specified table.
HandlerCtx.PackageEntry	addTransformXML(javax.xml.transform.Source in, javax.xml.transform.Source xslt) Adds an arbitrary Source representing XML data, which is converted via the provided xslt source to the package.
HandlerCtx.PackageEntry	addTransformXML(javax.xml.transform.Source document, javax.xml.transform.Source xslt, java.util.Map<java.lang.String,java.lang.String> parameters) Adds an arbitrary Source representing XML data, which is converted via the provided xslt source to the package using the XSLT parameters from the Map.
HandlerCtx.PackageDependency	addURL(java.lang.String url) Adds a custom url to be included within the package.
HandlerCtx.XMLWriterEntry	addXML()
HandlerCtx.PackageEntry	addXML(org.w3c.dom.Document doc) Adds a DOM document
HandlerCtx.PackageEntry	addXML(org.xml.sax.InputSource in) Adds an arbitrary InputSource to the package.
UserData	getUserData() Returns the UserData containing relevant information about how this handler were instantiated.
boolean	removeDependency(HandlerCtx.PackageDependency dep) Removes a previously added dependency.

Method Detail

getUserData

UserData getUserData()

Returns the UserData containing relevant information about how this handler were instantiated.

Returns:

The user data

add

HandlerCtx.PackageEntry add(java.io.InputStream in)

Adds an arbitrary InputStream to the package.

Parameters:

in - The input stream, which the data is read from

Returns:

A entry used for defining properties on the entry.

add

HandlerCtx.PackageEntry add(java.io.Reader reader)

Adds an arbitrary Reader to the package.

Parameters:

reader - The reader, which the data is read from

Returns:

A entry used for defining properties on the entry.

add

HandlerCtx.PackageEntry add(java.lang.String data)

Adds an arbitrary string to the package.

Parameters:

data - The data to be added

Returns:

A entry used for defining properties on the entry.

Since:

6.3.1

addXML

HandlerCtx.XMLWriterEntry addXML()

Returns:

An HandlerCtx.XMLWriterEntry, to which you can write XML data.

Since:

6.1.4

addXML

HandlerCtx.PackageEntry addXML(org.w3c.dom.Document doc)

Adds a DOM document

Parameters:

doc -

Returns:

A entry used for defining properties on the entry.

addXML

HandlerCtx.PackageEntry addXML(org.xml.sax.InputSource in)

Adds an arbitrary InputSource to the package.

Parameters:

in - The input source, which the XML data is read from

Returns:

A entry used for defining properties on the entry.

addURL

HandlerCtx.PackageDependency addURL(java.lang.String url)

Adds a custom url to be included within the package.

Parameters:

url - The url to add. If the url doesnt start with HTTP or HTTPS, the url is considered to be relative to the application context path.

Returns:

A dependency

Since:

6.1.4

addTransformXML

HandlerCtx.PackageEntry addTransformXML(javax.xml.transform.Source in,
                                        javax.xml.transform.Source xslt)

Adds an arbitrary Source representing XML data, which is converted via the provided xslt source to the package.

Parameters:

in - The XML source

xslt - The XSLT source.

Returns:

A entry used for defining properties on the entry.

addTransformXML

HandlerCtx.PackageEntry addTransformXML(javax.xml.transform.Source document,
                                        javax.xml.transform.Source xslt,
                                        java.util.Map<java.lang.String,java.lang.String> parameters)

Adds an arbitrary Source representing XML data, which is converted via the provided xslt source to the package using the XSLT parameters from the Map.

Parameters:

document - The XML source

xslt - The XSLT source.

parameters - The parameter map

Returns:

A entry used for defining properties on the entry.

addPageContent

HandlerCtx.PackageEntry addPageContent(java.lang.String pageName)

Adds the content of a page object as resource

Parameters:

pageName - The name of the page object to include in the package.

Returns:

A entry used for defining properties on the entry.

addExportBus

HandlerCtx.PackageEntry addExportBus(java.lang.String typePattern,
                                     java.lang.String namePattern,
                                     java.lang.String revPattern)

Adds the result of a export businessobject output

Parameters:

typePattern - The type pattern

namePattern - The name pattern

revPattern - The revision pattern

Returns:

A entry used for defining properties on the entry.

addExportBus

HandlerCtx.PackageEntry addExportBus(java.lang.String typePattern,
                                     java.lang.String namePattern,
                                     java.lang.String revPattern,
                                     javax.xml.transform.Source xslt,
                                     java.util.Map<java.lang.String,java.lang.String> parameters)

Adds the result of a export businessobject output transformed via the provided XSLT stylesheet.

Parameters:

typePattern - The type pattern

namePattern - The name pattern

revPattern - The revision pattern

xslt - The stylesheet

parameters - A map containing parameters (optional)

Returns:

A entry used for defining properties on the entry.

addExportBus

HandlerCtx.PackageEntry addExportBus(java.lang.String typePattern,
                                     java.lang.String namePattern,
                                     java.lang.String revPattern,
                                     boolean files,
                                     boolean captured,
                                     boolean icons,
                                     boolean history,
                                     boolean fromRelationships,
                                     boolean toRelationships,
                                     boolean states,
                                     boolean archive,
                                     javax.xml.transform.Source xslt,
                                     java.util.Map<java.lang.String,java.lang.String> parameters)

Adds the result of a export business object output transformed via the provided XSLT stylesheet.

Parameters:

typePattern -

namePattern -

revPattern -

files -

captured -

icons -

history -

fromRelationships -

toRelationships -

states -

archive -

xslt -

parameters -

Returns:

A entry used for defining properties on the entry.

addJPO

HandlerCtx.PackageEntry addJPO(java.lang.String jpo,
                               java.lang.String function)

Adds the output from a JPO execution.

Parameters:

jpo -

function -

Returns:

A entry used for defining properties on the entry.

addJPO

HandlerCtx.PackageEntry addJPO(java.lang.String jpo,
                               java.lang.String function,
                               java.io.Serializable argument)

Adds the output from a JPO execution. The provided argument is passed to the JPO.

Parameters:

jpo - The name of the JPO to invoke

function - The name of the method to invoke.

argument - An argument.

Returns:

A entry used for defining properties on the entry.

addMQL

HandlerCtx.PackageEntry addMQL(java.lang.String mqlCommand)

Adds the output from a MQL command execution. Calls addMQL(String, boolean) with second arg set to true.

Parameters:

mqlCommand - The command to execute

Returns:

A entry used for defining properties on the entry.

addMQL

HandlerCtx.PackageEntry addMQL(java.lang.String mqlCommand,
                               boolean parseMacros)

Adds mql code, and parses the mql code and resolves any macros before the command is executed.

Parameters:

mqlCommand - The command to execute.

parseMacros - True of false if to parse macros

Returns:

A entry used for defining properties on the entry.

Since:

6.1.4

addMQL

HandlerCtx.PackageEntry addMQL(java.lang.String mqlCommand,
                               java.util.Map<java.lang.String,java.lang.String> macros)

Adds mql code, and parses the mql code and resolves the macros within the provided map (if available), before the command is executed.

Parameters:

mqlCommand - The command to be executed

macros - The map containing the macros to be substituted.

Returns:

A entry used for defining properties on the entry.

Since:

6.3.1

addFile

HandlerCtx.PackageEntry addFile(java.lang.String type,
                                java.lang.String name,
                                java.lang.String revision,
                                java.lang.String format,
                                java.lang.String fileName)

Adds a file from a businessobject to the package.

Parameters:

type - The type

name - The name

revision - The revision

format - The format

fileName - The name of the file

Returns:

A entry used for defining properties on the entry.

addFile

HandlerCtx.PackageEntry addFile(java.lang.String type,
                                java.lang.String name,
                                java.lang.String revision,
                                java.lang.String vault,
                                java.lang.String format,
                                java.lang.String fileName)

Adds a file from a businessobject to the package.

Parameters:

type - The object type

name - The object name

revision - The object revision

vault - The vault, which the object is stored in

format - The format of the file

fileName - The name of the file

Returns:

A entry used for defining properties on the entry.

Since:

6.1.6

addFile

HandlerCtx.PackageEntry addFile(java.lang.String objectId,
                                java.lang.String format,
                                java.lang.String fileName)

Adds a file from a businessobject to the package.

Parameters:

objectId - The id of the object

format - The format

fileName - The name of the file

Returns:

A entry used for defining properties on the entry.

addDataProvider

HandlerCtx.PackageEntry addDataProvider(DataProvider dataProvider)

Adds an arbitrary data provider to the package

Parameters:

dataProvider -

Returns:

A entry used for defining properties on the entry.

addExpandedData

HandlerCtx.TableExportEntry addExpandedData(java.lang.String rootObjectId,
                                            java.lang.String roleName,
                                            java.lang.String[] filterNames,
                                            int expandLevels,
                                            java.lang.String tableName)

Adds the output from a structure expansion

Parameters:

rootObjectId - The id of the object to expand

roleName - The name of the role, which the filters are stored on.

filterNames - The names of the filters to use.

expandLevels - The number of levels to expand

tableName - The name of the table to apply on the result

Returns:

A HandlerCtx.TableExportEntry

addExpandedData

HandlerCtx.TableExportEntry addExpandedData(java.lang.String[] rootObjectIds,
                                            java.lang.String roleName,
                                            java.lang.String[] filterNames,
                                            int expandLevels,
                                            java.lang.String tableName)

Adds the output from a structure expansion

Parameters:

rootObjectIds - The id's of the object's to expand

roleName - The name of the role, which the filters are stored on.

filterNames - The names of the filters to use.

expandLevels - The number of levels to expand

tableName - The name of the table to apply on the result

Returns:

A HandlerCtx.TableExportEntry

addTableData

HandlerCtx.TableExportEntry addTableData(java.lang.String inquiryName,
                                         java.util.Map<java.lang.String,java.lang.String> args,
                                         java.lang.String tableName)

Adds the objects returned by the specified inquiry, evaluated with the specified table.

Parameters:

inquiryName - The name of the inquiry to invoke

args - The inquiry arguments

tableName - The name of the table to apply on the result

Returns:

A HandlerCtx.TableExportEntry

addTableData

HandlerCtx.TableExportEntry addTableData(java.lang.String jpoName,
                                         java.lang.String function,
                                         java.util.Map<java.lang.String,java.lang.String> args,
                                         java.lang.String tableName)

Adds the objects returned by the specified JPO, evaluated with the specified table.

Parameters:

jpoName - The name of the JPO to invoke

function - The name of the function to invoke.

args - The JPO arguments

tableName - The name of the table to apply on the result

Returns:

A HandlerCtx.TableExportEntry

addTableData

HandlerCtx.TableExportEntry addTableData(java.lang.String typePattern,
                                         java.lang.String namePattern,
                                         java.lang.String revPattern,
                                         java.lang.String ownerPattern,
                                         java.lang.String vaultPattern,
                                         java.lang.String whereClause,
                                         int limit,
                                         boolean expandType,
                                         java.lang.String tableName)

Adds the objects returned by the query arguments, evaluated with the specified table.

Parameters:

typePattern - The type pattern

namePattern - The name pattern

revPattern - The revision pattern

ownerPattern - The owner pattern

vaultPattern - The vault pattern

whereClause - The where clause

limit - The query limit

expandType - True if to include sub types to the specified type pattern

tableName - The name of the table to apply on the result

Returns:

A HandlerCtx.TableExportEntry

addTableData

HandlerCtx.TableExportEntry addTableData(java.lang.String dataSet,
                                         java.lang.String tableName)

Parameters:

dataSet -

tableName -

Returns:

A HandlerCtx.TableExportEntry

Since:

2011.3.0

addTable

HandlerCtx.TableExportEntry addTable(TableBean<? extends TableData> table)

Adds a custom table bean to the package.

Parameters:

table - The tablebean to add.

Returns:

A HandlerCtx.TableExportEntry

addFileDependency

HandlerCtx.PackageDependency addFileDependency(java.lang.String type,
                                               java.lang.String name,
                                               java.lang.String revision,
                                               java.lang.String format,
                                               java.lang.String fileName)

Adds a file dependency

Parameters:

type - The object type

name - The object name

revision - The object revision

format - The format of the file

fileName - The name of the file

Returns:

A dependency used for defining properties on the entry.

addFileDependency

HandlerCtx.PackageDependency addFileDependency(java.lang.String type,
                                               java.lang.String name,
                                               java.lang.String revision,
                                               java.lang.String vault,
                                               java.lang.String format,
                                               java.lang.String fileName)

Adds a file dependency

Parameters:

type - The object type

name - The object name

revision - The object revision

vault - The vault, which the object is stored in

format - The format of the file

fileName - The name of the file

Returns:

A dependency used for defining properties on the entry.

addFileDependency

HandlerCtx.PackageDependency addFileDependency(java.lang.String objectId,
                                               java.lang.String format,
                                               java.lang.String fileName)

Adds a file dependency

Parameters:

objectId - The id of the object

format - The format of the fil

fileName - The name of the file

Returns:

A dependency used for defining properties on the entry.

removeDependency

boolean removeDependency(HandlerCtx.PackageDependency dep)

Removes a previously added dependency.

Parameters:

dep - The depenency to be removed

Returns:

True if the dependency was removed

addReleasableResource

void addReleasableResource(com.technia.tvc.office.server.fpd.ReleasableResource rr)

Adds something needed to be released at the same time as the package is released.

Parameters:

rr - The resource to be released afterward

Since:

6.1.0