# Class: OrgModelService

## tibco.objectapi.service.OrgModelService

#### new OrgModelService()

### Methods

#### deleteCalendarReference(request, callback)

Deletes any calendar reference from the identified organization model entity.

##### Parameters:

Name | Type | Description
--- | --- | ---
`request` | tibco.objectapi.service.request.DeleteCalendarReferenceRequest | A request set with data for this service call.
`callback` | tibco.objectapi.service.Callback | A callback to handle the service response of type `NoContentResponse`.

#### deleteGroupCandidateQuery(request, callback)

Deletes any candidate query assignment from the identified group.

##### Parameters:

Name | Type | Description
--- | --- | ---
`request` | tibco.objectapi.service.request.DeleteGroupCandidateQueryRequest | A request set with data for this service call.
`callback` | tibco.objectapi.service.Callback | A callback to handle the service response of type `NoContentResponse`.

#### deletePositionCandidateQuery(request, callback)

Deletes any candidate query assignment from the identified position.

##### Parameters:

Name | Type | Description
--- | --- | ---
`request` | tibco.objectapi.service.request.DeletePositionCandidateQueryRequest | A request set with data for this service call.
`callback` | tibco.objectapi.service.Callback | A callback to handle the service response of type `NoContentResponse`.

#### deletePushDestination(request, callback)

Deletes the identified push destination assignment from the identified organization model entity.

##### Parameters:

Name | Type | Description
--- | --- | ---
`request` | tibco.objectapi.service.request.DeletePushDestinationRequest | A request set with data for this service call.
`callback` | tibco.objectapi.service.Callback | A callback to handle the service response of type `NoContentResponse`.

#### getCalendarReferences(request, callback)

Returns the calendar references for the identified organization model entity.

The response is an ordered collection of calendar references obtained by navigating the organization model hierarchy to which the identified model entity belongs. Each entry identifies the organization model entity that holds the calendar reference.

##### Parameters:

Name | Type | Description
--- | --- | ---
`request` | tibco.objectapi.service.request.GetCalendarReferencesRequest | A request set with data for this service call.
`callback` | tibco.objectapi.service.Callback | A callback to handle the service response of type `GetCalendarReferencesResponseType`.

#### getOrgModel(request, callback)

Requests the details of the entities that form the organization model identified by the given major version.

##### Parameters:

Name | Type | Description
--- | --- | ---
`request` | tibco.objectapi.service.request.GetOrgModelRequest | A request set with data for this service call.
`callback` | tibco.objectapi.service.Callback | A callback to handle the service response of type `GetOrgModelResponseType`.

#### getOrgModelEntity(request, callback)

Requests the details of the specified organization model entity.

This function can be used in conjunction with the getOrgModelRoots function to "drill down" into an organization model structure to obtain details about one or more organizational entities.

##### Parameters:

Name | Type | Description
--- | --- | ---
`request` | tibco.objectapi.service.request.GetOrgModelEntityRequest | A request set with data for this service call.
`callback` | tibco.objectapi.service.Callback | A callback to handle the service response of type `GetOrgModelEntityResponseType`.

#### getOrgModelRoots(request, callback)

Requests the details of the entities that form the root elements of the organization model identified by the given major version. These include organizations, groups, locations, capabilities, privileges, resource attributes, and model templates.

If the organization model is very large, you can use this function instead of getOrgModel to improve performance. This allows you to "drill down" into the organization model structure to retrieve specific fragments of the model. You can then use getOrgModelEntity to retrieve details about specific organizational entities.

##### Parameters:

Name | Type | Description
--- | --- | ---
`request` | tibco.objectapi.service.request.GetOrgModelRootsRequest | A request set with data for this service call.
`callback` | tibco.objectapi.service.Callback | A callback to handle the service response of type `GetOrgModelRootsResponseType`.

#### getPushDestination(request, callback)

Returns a single push destination for the specified organization model entity.

##### Parameters:

Name | Type | Description
--- | --- | ---
`request` | tibco.objectapi.service.request.GetPushDestinationRequest | A request set with data for this service call.
`callback` | tibco.objectapi.service.Callback | A callback to handle the service response of type `GetPushDestinationsResponseType`.

#### getPushDestinations(request, callback)

Returns the push destinations for the specified organization model entity.

##### Parameters:

Name | Type | Description
--- | --- | ---
`request` | tibco.objectapi.service.request.GetPushDestinationsRequest | A request set with data for this service call.
`callback` | tibco.objectapi.service.Callback | A callback to handle the service response of type `GetPushDestinationsResponseType`.

#### listOrgModelVersions(request, callback)

Lists all major versions of an organization model. For each major version, the organization model deployments that make up that version are detailed, giving their full version number, name and date deployed.

For each major version, the organization model deployments that make up that version will be detailed - giving their full version number, name and date deployed.

##### Parameters:

Name | Type | Description
--- | --- | ---
`request` | tibco.objectapi.service.request.ListOrgModelVersionsRequest | A request set with data for this service call.
`callback` | tibco.objectapi.service.Callback | A callback to handle the service response of type `ListOrgModelVersionsResponseType`.

#### setCalendarReference(request, callback)

Assigns a calendar reference to the identified organization model entity. The assignments overwrite any existing assignments to the same organization model entities.

##### Parameters:

Name | Type | Description
--- | --- | ---
`request` | tibco.objectapi.service.request.SetCalendarReferenceRequest | A request set with data for this service call.
`callback` | tibco.objectapi.service.Callback | A callback to handle the service response of type `NoContentResponse`.

#### setCalendarReferences(request, callback)

Assigns calendar references to the identified organization model entities.

The assignments overwrite any existing assignments to the same organization model entities.

##### Parameters:

Name | Type | Description
--- | --- | ---
`request` | tibco.objectapi.service.request.SetCalendarReferencesRequest | A request set with data for this service call.
`callback` | tibco.objectapi.service.Callback | A callback to handle the service response of type `NoContentResponse`.

#### setExtensionPoint(request, callback)

Sets or updates the extension point configuration for the identified organization model version.

The request must specify a reference to an organization model template that will be used to dynamically generate new organizational fragments directly below it.

Any existing configuration for the identified entities are overwritten. Attempting to overwrite an existing configuration for which model template instances have been generated causes a DirectoryEngineFault. Attempting to set the configuration for an organization model entity to which the caller does not have access causes a SecurityFault.

The new organizational fragments are generated at the date/time specified in the ExtensionPointProcessStartproperty in DE.Properties.

##### Parameters:

Name | Type | Description
--- | --- | ---
`request` | tibco.objectapi.service.request.SetExtensionPointRequest | A request set with data for this service call.
`callback` | tibco.objectapi.service.Callback | A callback to handle the service response of type `NoContentResponse`.

#### setGroupCandidateQuery(request, callback)

Sets or updates the candidate query assignments to the identified group.

Each group may only hold one candidate query. Any existing assignment is overwritten by a new assignment. Candidate queries span all organization model versions in which the identified organization model exists. Therefore, the request does not include a model version.

##### Parameters:

Name | Type | Description
--- | --- | ---
`request` | tibco.objectapi.service.request.SetGroupCandidateQueryRequest | A request set with data for this service call.
`callback` | tibco.objectapi.service.Callback | A callback to handle the service response of type `NoContentResponse`.

#### setPositionCandidateQuery(request, callback)

Sets or updates the candidate query assignments to the identified position.

Each position may only hold one candidate query. Any existing assignment is overwritten by a new assignment. Candidate queries span all organization model versions in which the identified organization model exists. Therefore, the request does not include a model version.

##### Parameters:

Name | Type | Description
--- | --- | ---
`request` | tibco.objectapi.service.request.SetPositionCandidateQueryRequest | A request set with data for this service call.
`callback` | tibco.objectapi.service.Callback | A callback to handle the service response of type `NoContentResponse`.

#### setPushDestination(request, callback)

Modifies the push destination for a specified organization model entity.

The value(s) of the push destination may be specified as 'hard-coded' collection of values (such as email addresses), or they may be derived from the Resource Attribute identified in the request.

Existing push destination values are overwritten.

To get existing push destinations, use the getResource function, for resources, or the getOrgModel function, for organization model entities other than resources.

##### Parameters:

Name | Type | Description
--- | --- | ---
`request` | tibco.objectapi.service.request.SetPushDestinationRequest | A request set with data for this service call.
`callback` | tibco.objectapi.service.Callback | A callback to handle the service response of type `NoContentResponse`.

#### updatePushDestinations(request, callback)

Updates the push destinations for the identified organization model entity.

The update can include the deletion of existing push destinations. Each push destination is identified by its name, channel-type and channel-id.

##### Parameters:

Name | Type | Description
--- | --- | ---
`request` | tibco.objectapi.service.request.UpdatePushDestinationsRequest | A request set with data for this service call.
`callback` | tibco.objectapi.service.Callback | A callback to handle the service response of type `NoContentResponse`.