com.tibco.n2.service.adapter.binding

Interface BrowseModelService

All Known Implementing Classes:

BrowseModelService

Deprecated.

recommend that OrgModelService be used instead.

public interface BrowseModelService

Interface to provide the BrowseModelService methods.

This service provides interfaces to allow a deployed Organisational Model to be browsed.

A normal sequence of events would be:

• Call listModelVersions to get the available Model Versions in the system.
• Call openOrgModel to open the top-level of the Org Model and get the root node entities and their immediate children.
• Call browseModelNode on a returned entity to get information about its children.

By repeatedly calling browseModelNode the model can be traversed from top to bottom.

listOrgModelOverview provides a complete view of the Organisational Model and gives summary information about each entity.

The following functionality is provided:

• Obtain the deployed Model Versions.
• Open a deployed Organisational Model.
• Obtain an overview of a deployed Organisational Model.
• Browse nodes within a deployed Organistaionl Model.

Method Summary

Methods

Modifier and Type	Method and Description
com.tibco.n2.de.api.XmlOrgModelNode	browseModelNode(int modelVersion, com.tibco.n2.common.organisation.api.OrganisationalEntityType.Enum entityType, java.lang.String guid, java.lang.String qualifier) Deprecated. since AMX-BPM 2.0.0 use OrgModelService#getOrgModel(com.tibco.bpm.de.api.orgmodel.GetOrgModelDocument).
com.tibco.n2.de.api.XmlModelEntity[]	getCapabilities(int modelVersion, com.tibco.n2.common.organisation.api.OrganisationalEntityType.Enum entityType, java.lang.String guid, java.lang.String qualifier) Deprecated. since AMX-BPM 2.0.0 use OrgModelService#getOrgModel(com.tibco.bpm.de.api.orgmodel.GetOrgModelDocument) to return all Groups and Positions along with their required Capabilities. For Resources, use OrgResourceService#getResource(com.tibco.bpm.de.api.resource.GetResourceDocument).
com.tibco.n2.de.api.XmlModelEntity[]	getPrivileges(int modelVersion, com.tibco.n2.common.organisation.api.OrganisationalEntityType.Enum entityType, java.lang.String guid, java.lang.String qualifier) Deprecated. since AMX-BPM 2.0.0 use OrgModelService#getOrgModel(com.tibco.bpm.de.api.orgmodel.GetOrgModelDocument) to return all Groups, Org-Units and Positions along with their Privileges.
com.tibco.n2.de.api.XmlQualifiedEntity[]	listCapabilities(int modelVersion) Deprecated. since AMX-BPM 2.0.0 use OrgModelService#getOrgModel(com.tibco.bpm.de.api.orgmodel.GetOrgModelDocument) to return all org-model entities - including Capabilities.
com.tibco.n2.de.api.XmlOrgModelVersionDetail[]	listModelVersions(boolean dummy) Deprecated. since AMX-BPM 2.0.0 use OrgModelService#listOrgModelVersions(com.tibco.bpm.de.api.orgmodel.ListOrgModelVersionsDocument).
com.tibco.n2.de.api.XmlModelEntity[]	listOrganizations(boolean dummy) Deprecated. since AMX-BPM 2.0.0 use OrgModelService#getOrgModel(com.tibco.bpm.de.api.orgmodel.GetOrgModelDocument).
com.tibco.n2.de.api.XmlOrgModelNode[]	listOrgModelOverview(int modelVersion) Deprecated. since AMX-BPM 2.0.0 use OrgModelService#getOrgModel(com.tibco.bpm.de.api.orgmodel.GetOrgModelDocument).
com.tibco.n2.de.api.XmlQualifiedEntity[]	listPrivileges(int modelVersion) Deprecated. since AMX-BPM 2.0.0 use OrgModelService#getOrgModel(com.tibco.bpm.de.api.orgmodel.GetOrgModelDocument) to return all org-model entities - including Privileges.
com.tibco.n2.de.api.XmlOrgModelNode[]	openOrgModel(int modelVersion) Deprecated. since AMX-BPM 2.0.0 use OrgModelService#getOrgModel(com.tibco.bpm.de.api.orgmodel.GetOrgModelDocument).

Method Detail

listModelVersions

com.tibco.n2.de.api.XmlOrgModelVersionDetail[] listModelVersions(boolean dummy)

                                                                 throws com.tibco.n2.de.services.InternalServiceFault

Deprecated. since AMX-BPM 2.0.0 use OrgModelService#listOrgModelVersions(com.tibco.bpm.de.api.orgmodel.ListOrgModelVersionsDocument).

Return a list of the available Organisational Models.

This method should be called before calling #openOrgModel(String) or #listOrgModelOverview(String) in order to obtain the Version Guid for the model version you wish to open.

Parameters:

dummy - Not used.

Returns:

Returns a List of XmlOrgModelVersion structures. Each one will contain the Version Guid ( guid ) and the Version Name ( version ).

Throws:

com.tibco.n2.de.services.InternalServiceFault

listOrgModelOverview

com.tibco.n2.de.api.XmlOrgModelNode[] listOrgModelOverview(int modelVersion)

                                                           throws com.tibco.n2.de.services.InvalidOrgModelVersionFault,

                                                                  com.tibco.n2.de.services.InternalServiceFault

Deprecated. since AMX-BPM 2.0.0 use OrgModelService#getOrgModel(com.tibco.bpm.de.api.orgmodel.GetOrgModelDocument).

Returns an overview of the organisational model.

This will include all the Organisations, Organisational Units, Positions and Groups.

For each entry the Name, Guid and Entity Type will be returned.

Parameters:

modelGuid - The Version Guid of the model version you wish to open ( obtained by calling listModelVersions )

Returns:

returns a List of XmlOrgModelNode structures. Each one will contain the Name, Guid, Entity Type and Model Version for a root node ( top level ) and the Name, Guid and Entity Type for child nodes.

Throws:

com.tibco.n2.de.services.InvalidOrgModelVersionFault

com.tibco.n2.de.services.InternalServiceFault

openOrgModel

com.tibco.n2.de.api.XmlOrgModelNode[] openOrgModel(int modelVersion)

                                                   throws com.tibco.n2.de.services.InvalidOrgModelVersionFault,

                                                          com.tibco.n2.de.services.InternalServiceFault

Deprecated. since AMX-BPM 2.0.0 use OrgModelService#getOrgModel(com.tibco.bpm.de.api.orgmodel.GetOrgModelDocument).

Retrieves the root node elements (and their immediate children) of a given version of the Organisational Model.

The caller can then iterate over the entire model by making repeated calls to browseModelNode passing the identifier of the node to be traversed.

Parameters:

modelGuid - The Version Guid of the model version you wish to open ( obtained by calling listModelVersions )

Returns:

returns a List of XmlOrgModelNode structures. Each one will contain the Name, Guid, Entity Type, Model Version and whether the node has children for a root node ( top level ) and the Name, Guid and Entity Type for child nodes.

Throws:

com.tibco.n2.de.services.InvalidOrgModelVersionFault

com.tibco.n2.de.services.InternalServiceFault

browseModelNode

com.tibco.n2.de.api.XmlOrgModelNode browseModelNode(int modelVersion,

                                                  com.tibco.n2.common.organisation.api.OrganisationalEntityType.Enum entityType,

                                                  java.lang.String guid,

                                                  java.lang.String qualifier)

                                                    throws com.tibco.n2.de.services.InvalidOrgModelVersionFault,

                                                           com.tibco.n2.de.services.InvalidEntityReferenceFault,

                                                           com.tibco.n2.de.services.InternalServiceFault

Deprecated. since AMX-BPM 2.0.0 use OrgModelService#getOrgModel(com.tibco.bpm.de.api.orgmodel.GetOrgModelDocument).

Returns the details of an identified organisational model entity.

The details will include the identifiers of the model entities referenced by the identified model entity; its children and other associations.

With this, the client can "drill-down" into the Organisational Model structure.

Parameters:

modelVersion - The Version Guid of the model version you wish to open.

entityType - Entity Type of the entity you wish to browse from.

guid - Guid of the entity you wish to browse from.

qualifier - qualifier

Returns:

returns a List of XmlOrgModelNode structures for the browsed node and its children. Each one will contain the Name, Guid, Entity Type, Model Version and whether the node has children For Positions the Ideal Number is also returned.

Throws:

com.tibco.n2.de.services.InvalidOrgModelVersionFault

com.tibco.n2.de.services.InvalidEntityReferenceFault

com.tibco.n2.de.services.InternalServiceFault

listPrivileges

com.tibco.n2.de.api.XmlQualifiedEntity[] listPrivileges(int modelVersion)

                                                        throws com.tibco.n2.de.services.InternalServiceFault,

                                                               com.tibco.n2.de.services.InvalidOrgModelVersionFault

Deprecated. since AMX-BPM 2.0.0 use OrgModelService#getOrgModel(com.tibco.bpm.de.api.orgmodel.GetOrgModelDocument) to return all org-model entities - including Privileges.

Lists the Privilege definitions within the organisational model.

The response will include detail about each Privilege including: GUID, name, entity type (always PRIVILEGE) and model version (if available).

If the Privilege is a "qualified" one, the details of Parameter Descriptor for the qualifier will also be listed. These include: ID, description, type and any default value. For ENUM or ENUMSET parameters, the list of possible values will also be given.

Returns:

a collection of Privilege definitions.

Throws:

com.tibco.n2.de.services.InternalServiceFault

com.tibco.n2.de.services.InvalidOrgModelVersionFault

listCapabilities

com.tibco.n2.de.api.XmlQualifiedEntity[] listCapabilities(int modelVersion)

                                                          throws com.tibco.n2.de.services.InternalServiceFault,

                                                                 com.tibco.n2.de.services.InvalidOrgModelVersionFault

Deprecated. since AMX-BPM 2.0.0 use OrgModelService#getOrgModel(com.tibco.bpm.de.api.orgmodel.GetOrgModelDocument) to return all org-model entities - including Capabilities.

Lists the Capability definitions within the organisational model.

The response will include detail about each Capability including: GUID, name, entity type (always CAPABILITY) and model version (if available).

If the Capability is a "qualified" one, the details of Parameter Descriptor for the qualifier will also be listed. These include: ID, description, type and any default value. For ENUM or ENUMSET parameters, the list of possible values will also be given.

Returns:

a collection of Capability definitions.

Throws:

com.tibco.n2.de.services.InternalServiceFault

com.tibco.n2.de.services.InvalidOrgModelVersionFault

getCapabilities

com.tibco.n2.de.api.XmlModelEntity[] getCapabilities(int modelVersion,

                                                   com.tibco.n2.common.organisation.api.OrganisationalEntityType.Enum entityType,

                                                   java.lang.String guid,

                                                   java.lang.String qualifier)

                                                     throws com.tibco.n2.de.services.InvalidEntityReferenceFault,

                                                            com.tibco.n2.de.services.InternalServiceFault,

                                                            com.tibco.n2.de.services.InvalidOrgModelVersionFault

Deprecated. since AMX-BPM 2.0.0 use OrgModelService#getOrgModel(com.tibco.bpm.de.api.orgmodel.GetOrgModelDocument) to return all Groups and Positions along with their required Capabilities. For Resources, use OrgResourceService#getResource(com.tibco.bpm.de.api.resource.GetResourceDocument).

Retrieves any Capabilities assigned directly to the org-model entity identified by the given parameters. For each Capability in the result set, the model version (if applicable), entity type (always CAPABILITY), GUID and name will be returned. If the assignment is a qualified one, the qualifying value will also be returned.

Parameters:

modelVersion - the identifier for the org-model version in which the org-model entity belongs.

entityType - the type of org-model entity whose Capabilities are to be retrieved.

guid - the unique identifier for the org-model entity whose Capabilities are to be retrieved.

qualifier - not used. This can be null.

Returns:

An array of Capability assignment definitions.

Throws:

com.tibco.n2.de.services.InvalidEntityReferenceFault

com.tibco.n2.de.services.InternalServiceFault

com.tibco.n2.de.services.InvalidOrgModelVersionFault

getPrivileges

com.tibco.n2.de.api.XmlModelEntity[] getPrivileges(int modelVersion,

                                                 com.tibco.n2.common.organisation.api.OrganisationalEntityType.Enum entityType,

                                                 java.lang.String guid,

                                                 java.lang.String qualifier)

                                                   throws com.tibco.n2.de.services.InvalidEntityReferenceFault,

                                                          com.tibco.n2.de.services.InternalServiceFault,

                                                          com.tibco.n2.de.services.InvalidOrgModelVersionFault

Deprecated. since AMX-BPM 2.0.0 use OrgModelService#getOrgModel(com.tibco.bpm.de.api.orgmodel.GetOrgModelDocument) to return all Groups, Org-Units and Positions along with their Privileges.

Retrieves any Privileges assigned directly to the org-model entity identified by the given parameters. For each Privilege in the result set, the model version (if applicable), entity type (always PRIVILEGE), GUID and name will be returned. If the assignment is a qualified one, the qualifying value will also be returned.

Parameters:

modelVersion - the identifier for the org-model version in which the org-model entity belongs.

entityType - the type of org-model entity whose Privileges are to be retrieved.

guid - the unique identifier for the org-model entity whose Privileges are to be retrieved.

qualifier - not used. This can be null.

Returns:

An array of Privilege assignment definitions.

Throws:

com.tibco.n2.de.services.InvalidEntityReferenceFault

com.tibco.n2.de.services.InternalServiceFault

com.tibco.n2.de.services.InvalidOrgModelVersionFault

listOrganizations

com.tibco.n2.de.api.XmlModelEntity[] listOrganizations(boolean dummy)

                                                       throws com.tibco.n2.de.services.InternalServiceFault

Deprecated. since AMX-BPM 2.0.0 use OrgModelService#getOrgModel(com.tibco.bpm.de.api.orgmodel.GetOrgModelDocument).

Return a list of the available Organisations.

This method will only be used if the user wishes to apply Organisation restrictions on an LDAP container.

Parameters:

dummy - Not used.

Returns:

Returns a list of xmlModelEntityId's for every Organization/version

Throws:

com.tibco.n2.de.services.InternalServiceFault