public interface AttributeService
Business parameters may be defined as part of a deployed organisation model. DE can then either map these business parameters to attributes stored within an LDAP directory, or store simple values itself. At runtime these parameter values can then be retrieved from DE either locally or from an LDAP source.
System parameters are stored completely within DE and values for these parameters will be set via the M&M interface.
Modifier and Type | Method and Description |
---|---|
com.tibco.n2.de.api.XmlLdapAttribute[] |
getBusinessParameters(int modelVersion,
com.tibco.n2.common.organisation.api.OrganisationalEntityType.Enum entityType,
java.lang.String guid,
java.lang.String qualifier)
Retrieves the Business Parameter values for the identified model entity.
|
com.tibco.n2.de.api.attribute.XmlPushDestinationList[] |
getPushDestinations(com.tibco.n2.common.organisation.api.XmlModelEntityId[] parameterValues)
Returns the PushDestinations that can be assigned to various org-model
entities.
|
com.tibco.n2.de.api.XmlParamDescriptor[] |
listBusinessParameters(int modelVersion)
Returns the Business Parameters that can be assigned to various org-model
entities.
|
boolean |
setBusinessParameters(int modelVersion,
com.tibco.n2.common.organisation.api.OrganisationalEntityType.Enum entityType,
java.lang.String guid,
java.lang.String qualifier,
com.tibco.n2.de.api.XmlLdapAttribute[] parameterValues)
Sets the Business Parameter values for the identified model entity.
|
boolean |
setPushDestinations(int modelVersion,
com.tibco.n2.common.organisation.api.OrganisationalEntityType.Enum entityType,
java.lang.String guid,
java.lang.String qualifier,
com.tibco.n2.de.api.attribute.XmlPushDestinationDocument.XmlPushDestination[] parameterValues)
Creates, Modifies or Deletes the PushDestinations that can be assigned to various org-model
entities.
|
com.tibco.n2.de.api.XmlParamDescriptor[] listBusinessParameters(int modelVersion) throws com.tibco.n2.de.services.InternalServiceFault, com.tibco.n2.de.services.InvalidOrgModelVersionFault
modelVersion
- the version of the model.List
of Business Parameters.java.lang.RuntimeException
com.tibco.n2.de.services.InternalServiceFault
com.tibco.n2.de.services.InvalidOrgModelVersionFault
com.tibco.n2.de.api.attribute.XmlPushDestinationList[] getPushDestinations(com.tibco.n2.common.organisation.api.XmlModelEntityId[] parameterValues) throws com.tibco.n2.de.services.InternalServiceFault, com.tibco.n2.de.services.InvalidEntityReferenceFault, com.tibco.n2.de.services.InvalidOrgModelVersionFault
XMLEntity
- a List
of Entities to get the Push Destinations forList
of Push Destinationsjava.lang.RuntimeException
com.tibco.n2.de.services.InternalServiceFault
com.tibco.n2.de.services.InvalidEntityReferenceFault
com.tibco.n2.de.services.InvalidOrgModelVersionFault
boolean setPushDestinations(int modelVersion, com.tibco.n2.common.organisation.api.OrganisationalEntityType.Enum entityType, java.lang.String guid, java.lang.String qualifier, com.tibco.n2.de.api.attribute.XmlPushDestinationDocument.XmlPushDestination[] parameterValues) throws com.tibco.n2.de.services.InternalServiceFault, com.tibco.n2.de.services.InvalidEntityReferenceFault, com.tibco.n2.de.services.InvalidOrgModelVersionFault
modelVersion
- optional model versionentityType
- entity type typically this will be RESOURCEguid
- guid identifying the resourcequalifier
- optional qualifierparameterValues
- a List
of Push Destinations to be settrue
value indicating if the call
was successful, otherwise false
java.lang.RuntimeException
com.tibco.n2.de.services.InternalServiceFault
com.tibco.n2.de.services.InvalidEntityReferenceFault
com.tibco.n2.de.services.InvalidOrgModelVersionFault
com.tibco.n2.de.api.XmlLdapAttribute[] getBusinessParameters(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.InternalServiceFault, com.tibco.n2.de.services.InvalidEntityReferenceFault, com.tibco.n2.de.services.InvalidOrgModelVersionFault
modelVersion
- optional model versionentityType
- entity type typically this will be RESOURCEguid
- guid identifying the resourcequalifier
- optional qualifierList
of Business Parametersjava.lang.RuntimeException
com.tibco.n2.de.services.InternalServiceFault
com.tibco.n2.de.services.InvalidEntityReferenceFault
com.tibco.n2.de.services.InvalidOrgModelVersionFault
boolean setBusinessParameters(int modelVersion, com.tibco.n2.common.organisation.api.OrganisationalEntityType.Enum entityType, java.lang.String guid, java.lang.String qualifier, com.tibco.n2.de.api.XmlLdapAttribute[] parameterValues) throws com.tibco.n2.de.services.InternalServiceFault, com.tibco.n2.de.services.InvalidEntityReferenceFault, com.tibco.n2.de.services.InvalidOrgModelVersionFault
This service will delete existing parameters not specified in the request.
To make sure existing values are maintained, the request must include them,
even in they are not modified. Use the response from getBusinessParameters(int, com.tibco.n2.common.organisation.api.OrganisationalEntityType.Enum, java.lang.String, java.lang.String)
as the template for the request to this method.
modelVersion
- optional model versionentityType
- entity type typically this will be RESOURCEguid
- guid identifying the resourcequalifier
- optional qualifierparameterValues
- a List
of Business Parameters to be settrue
value indicating if the call
was successful, otherwise false
java.lang.RuntimeException
com.tibco.n2.de.services.InternalServiceFault
com.tibco.n2.de.services.InvalidEntityReferenceFault
com.tibco.n2.de.services.InvalidOrgModelVersionFault
Copyright © 2014 TIBCO Software Inc. All Rights Reserved.