SubjectAreaBeansToAccessOMRS (Subject Area OMAS Server-side 1.0 API)

java.lang.Object
- org.odpi.openmetadata.accessservices.subjectarea.generated.server.SubjectAreaBeansToAccessOMRS

```
public class SubjectAreaBeansToAccessOMRS
extends Object
```
The OMRS API exposes concepts like Entities Relationships and Classifications, all of which have properties. So the Subject Area OMAS can more easily consume this content, a subset of the OMRS content is exposed as java beans. These java beans are accessed using this class.

Constructor Summary

Constructors
Constructor and Description

SubjectAreaBeansToAccessOMRS()

Constructors
Constructor and Description
`SubjectAreaBeansToAccessOMRS()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ActorProfile`	`addActorProfileClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied actorProfile
`APIOperation`	`addAPIOperationClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied aPIOperation
`APISchemaType`	`addAPISchemaTypeClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied aPISchemaType
`Application`	`addApplicationClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied application
`Asset`	`addAssetClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied asset
`BusinessCapability`	`addBusinessCapabilityClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied businessCapability
`CertificationType`	`addCertificationTypeClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied certificationType
`CohortMember`	`addCohortMemberClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied cohortMember
`Collection`	`addCollectionClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied collection
`Comment`	`addCommentClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied comment
`Community`	`addCommunityClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied community
`CommunityMember`	`addCommunityMemberClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied communityMember
`ComplexSchemaType`	`addComplexSchemaTypeClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied complexSchemaType
`Connection`	`addConnectionClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied connection
`ConnectorType`	`addConnectorTypeClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied connectorType
`ContactDetails`	`addContactDetailsClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied contactDetails
`DataFile`	`addDataFileClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied dataFile
`DataSet`	`addDataSetClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied dataSet
`DeployedAPI`	`addDeployedAPIClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied deployedAPI
`DeployedSoftwareComponent`	`addDeployedSoftwareComponentClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied deployedSoftwareComponent
`DerivedSchemaAttribute`	`addDerivedSchemaAttributeClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied derivedSchemaAttribute
`Endpoint`	`addEndpointClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied endpoint
`ExternalGlossaryLink`	`addExternalGlossaryLinkClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied externalGlossaryLink
`ExternalId`	`addExternalIdClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied externalId
`ExternalReference`	`addExternalReferenceClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied externalReference
`FileFolder`	`addFileFolderClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied fileFolder
`GlossaryCategory`	`addGlossaryCategoryClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied glossaryCategory
`Glossary`	`addGlossaryClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied glossary
`GlossaryTerm`	`addGlossaryTermClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied glossaryTerm
`GovernanceControl`	`addGovernanceControlClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied governanceControl
`GovernanceDefinition`	`addGovernanceDefinitionClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied governanceDefinition
`GovernanceDriver`	`addGovernanceDriverClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied governanceDriver
`GovernanceMetric`	`addGovernanceMetricClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied governanceMetric
`GovernancePolicy`	`addGovernancePolicyClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied governancePolicy
`GovernanceProcess`	`addGovernanceProcessClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied governanceProcess
`GovernanceResponsibility`	`addGovernanceResponsibilityClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied governanceResponsibility
`GovernanceRule`	`addGovernanceRuleClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied governanceRule
`GovernanceZone`	`addGovernanceZoneClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied governanceZone
`GraphEdge`	`addGraphEdgeClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied graphEdge
`GraphVertex`	`addGraphVertexClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied graphVertex
`Host`	`addHostClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied host
`HostCluster`	`addHostClusterClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied hostCluster
`ImplementationSnippet`	`addImplementationSnippetClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied implementationSnippet
`InformalTag`	`addInformalTagClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied informalTag
`LicenseType`	`addLicenseTypeClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied licenseType
`Like`	`addLikeClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied like
`Location`	`addLocationClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied location
`MapSchemaType`	`addMapSchemaTypeClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied mapSchemaType
`MediaCollection`	`addMediaCollectionClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied mediaCollection
`MediaFile`	`addMediaFileClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied mediaFile
`Meeting`	`addMeetingClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied meeting
`MetadataCollection`	`addMetadataCollectionClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied metadataCollection
`MetadataRepositoryCohort`	`addMetadataRepositoryCohortClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied metadataRepositoryCohort
`Network`	`addNetworkClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied network
`NetworkGateway`	`addNetworkGatewayClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied networkGateway
`NoteEntry`	`addNoteEntryClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied noteEntry
`NoteLog`	`addNoteLogClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied noteLog
`OperatingPlatform`	`addOperatingPlatformClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied operatingPlatform
`Person`	`addPersonClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied person
`Process`	`addProcessClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied process
`ProjectCharter`	`addProjectCharterClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied projectCharter
`Project`	`addProjectClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied project
`PropertyFacet`	`addPropertyFacetClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied propertyFacet
`Rating`	`addRatingClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied rating
`Referenceable`	`addReferenceableClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied referenceable
`Regulation`	`addRegulationClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied regulation
`RelatedMedia`	`addRelatedMediaClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied relatedMedia
`SchemaAttribute`	`addSchemaAttributeClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied schemaAttribute
`SchemaLinkElement`	`addSchemaLinkElementClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied schemaLinkElement
`SchemaType`	`addSchemaTypeClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied schemaType
`SoftwareServerCapability`	`addSoftwareServerCapabilityClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied softwareServerCapability
`SoftwareServer`	`addSoftwareServerClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied softwareServer
`SoftwareServerPlatform`	`addSoftwareServerPlatformClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied softwareServerPlatform
`SubscriberList`	`addSubscriberListClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied subscriberList
`Team`	`addTeamClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied team
`ToDo`	`addToDoClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied toDo
`Topic`	`addTopicClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied topic
`UserIdentity`	`addUserIdentityClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied userIdentity
`VirtualConnection`	`addVirtualConnectionClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied virtualConnection
`VirtualContainer`	`addVirtualContainerClassifications(String userId, String entityGuid, List<Classification> classifications)` Add classifications to the supplied virtualContainer
`AcceptedAnswer`	`createAcceptedAnswerRelationship(String userId, AcceptedAnswer relationship)` Create AcceptedAnswer relationship
`ActorProfile`	`createActorProfile(String userId, ActorProfile actorProfile)` Create new actorProfile.
`AdjacentLocation`	`createAdjacentLocationRelationship(String userId, AdjacentLocation relationship)` Create AdjacentLocation relationship
`Antonym`	`createAntonymRelationship(String userId, Antonym relationship)` Create Antonym relationship
`APIEndpoint`	`createAPIEndpointRelationship(String userId, APIEndpoint relationship)` Create APIEndpoint relationship
`APIHeader`	`createAPIHeaderRelationship(String userId, APIHeader relationship)` Create APIHeader relationship
`APIOperation`	`createAPIOperation(String userId, APIOperation aPIOperation)` Create new aPIOperation.
`APIOperations`	`createAPIOperationsRelationship(String userId, APIOperations relationship)` Create APIOperations relationship
`APIRequest`	`createAPIRequestRelationship(String userId, APIRequest relationship)` Create APIRequest relationship
`APIResponse`	`createAPIResponseRelationship(String userId, APIResponse relationship)` Create APIResponse relationship
`APISchemaType`	`createAPISchemaType(String userId, APISchemaType aPISchemaType)` Create new aPISchemaType.
`Application`	`createApplication(String userId, Application application)` Create new application.
`Asset`	`createAsset(String userId, Asset asset)` Create new asset.
`AssetLocation`	`createAssetLocationRelationship(String userId, AssetLocation relationship)` Create AssetLocation relationship
`AssetSchemaType`	`createAssetSchemaTypeRelationship(String userId, AssetSchemaType relationship)` Create AssetSchemaType relationship
`AssetServerUse`	`createAssetServerUseRelationship(String userId, AssetServerUse relationship)` Create AssetServerUse relationship
`AttachedComment`	`createAttachedCommentRelationship(String userId, AttachedComment relationship)` Create AttachedComment relationship
`AttachedLike`	`createAttachedLikeRelationship(String userId, AttachedLike relationship)` Create AttachedLike relationship
`AttachedNoteLogEntry`	`createAttachedNoteLogEntryRelationship(String userId, AttachedNoteLogEntry relationship)` Create AttachedNoteLogEntry relationship
`AttachedNoteLog`	`createAttachedNoteLogRelationship(String userId, AttachedNoteLog relationship)` Create AttachedNoteLog relationship
`AttachedRating`	`createAttachedRatingRelationship(String userId, AttachedRating relationship)` Create AttachedRating relationship
`AttachedTag`	`createAttachedTagRelationship(String userId, AttachedTag relationship)` Create AttachedTag relationship
`AttributeForSchema`	`createAttributeForSchemaRelationship(String userId, AttributeForSchema relationship)` Create AttributeForSchema relationship
`BusinessCapability`	`createBusinessCapability(String userId, BusinessCapability businessCapability)` Create new businessCapability.
`CategoryAnchor`	`createCategoryAnchorRelationship(String userId, CategoryAnchor relationship)` Create CategoryAnchor relationship
`CategoryHierarchyLink`	`createCategoryHierarchyLinkRelationship(String userId, CategoryHierarchyLink relationship)` Create CategoryHierarchyLink relationship
`Certification`	`createCertificationRelationship(String userId, Certification relationship)` Create Certification relationship
`CertificationType`	`createCertificationType(String userId, CertificationType certificationType)` Create new certificationType.
`CohortMember`	`createCohortMember(String userId, CohortMember cohortMember)` Create new cohortMember.
`CohortMemberMetadataCollection`	`createCohortMemberMetadataCollectionRelationship(String userId, CohortMemberMetadataCollection relationship)` Create CohortMemberMetadataCollection relationship
`Collection`	`createCollection(String userId, Collection collection)` Create new collection.
`Comment`	`createComment(String userId, Comment comment)` Create new comment.
`Community`	`createCommunity(String userId, Community community)` Create new community.
`CommunityMember`	`createCommunityMember(String userId, CommunityMember communityMember)` Create new communityMember.
`CommunityMembership`	`createCommunityMembershipRelationship(String userId, CommunityMembership relationship)` Create CommunityMembership relationship
`ComplexSchemaType`	`createComplexSchemaType(String userId, ComplexSchemaType complexSchemaType)` Create new complexSchemaType.
`Connection`	`createConnection(String userId, Connection connection)` Create new connection.
`ConnectionConnectorType`	`createConnectionConnectorTypeRelationship(String userId, ConnectionConnectorType relationship)` Create ConnectionConnectorType relationship
`ConnectionEndpoint`	`createConnectionEndpointRelationship(String userId, ConnectionEndpoint relationship)` Create ConnectionEndpoint relationship
`ConnectionToAsset`	`createConnectionToAssetRelationship(String userId, ConnectionToAsset relationship)` Create ConnectionToAsset relationship
`ConnectorType`	`createConnectorType(String userId, ConnectorType connectorType)` Create new connectorType.
`ContactDetails`	`createContactDetails(String userId, ContactDetails contactDetails)` Create new contactDetails.
`ContactThrough`	`createContactThroughRelationship(String userId, ContactThrough relationship)` Create ContactThrough relationship
`DataContentForDataSet`	`createDataContentForDataSetRelationship(String userId, DataContentForDataSet relationship)` Create DataContentForDataSet relationship
`DataFile`	`createDataFile(String userId, DataFile dataFile)` Create new dataFile.
`DataSet`	`createDataSet(String userId, DataSet dataSet)` Create new dataSet.
`DeployedAPI`	`createDeployedAPI(String userId, DeployedAPI deployedAPI)` Create new deployedAPI.
`DeployedSoftwareComponent`	`createDeployedSoftwareComponent(String userId, DeployedSoftwareComponent deployedSoftwareComponent)` Create new deployedSoftwareComponent.
`DeployedVirtualContainer`	`createDeployedVirtualContainerRelationship(String userId, DeployedVirtualContainer relationship)` Create DeployedVirtualContainer relationship
`DerivedSchemaAttribute`	`createDerivedSchemaAttribute(String userId, DerivedSchemaAttribute derivedSchemaAttribute)` Create new derivedSchemaAttribute.
`EmbeddedConnection`	`createEmbeddedConnectionRelationship(String userId, EmbeddedConnection relationship)` Create EmbeddedConnection relationship
`Endpoint`	`createEndpoint(String userId, Endpoint endpoint)` Create new endpoint.
`ExternalGlossaryLink`	`createExternalGlossaryLink(String userId, ExternalGlossaryLink externalGlossaryLink)` Create new externalGlossaryLink.
`ExternalId`	`createExternalId(String userId, ExternalId externalId)` Create new externalId.
`ExternalIdLink`	`createExternalIdLinkRelationship(String userId, ExternalIdLink relationship)` Create ExternalIdLink relationship
`ExternalIdScope`	`createExternalIdScopeRelationship(String userId, ExternalIdScope relationship)` Create ExternalIdScope relationship
`ExternallySourcedGlossary`	`createExternallySourcedGlossaryRelationship(String userId, ExternallySourcedGlossary relationship)` Create ExternallySourcedGlossary relationship
`ExternalReference`	`createExternalReference(String userId, ExternalReference externalReference)` Create new externalReference.
`ExternalReferenceLink`	`createExternalReferenceLinkRelationship(String userId, ExternalReferenceLink relationship)` Create ExternalReferenceLink relationship
`FileFolder`	`createFileFolder(String userId, FileFolder fileFolder)` Create new fileFolder.
`FolderHierarchy`	`createFolderHierarchyRelationship(String userId, FolderHierarchy relationship)` Create FolderHierarchy relationship
`Glossary`	`createGlossary(String userId, Glossary glossary)` Create new glossary.
`GlossaryCategory`	`createGlossaryCategory(String userId, GlossaryCategory glossaryCategory)` Create new glossaryCategory.
`GlossaryTerm`	`createGlossaryTerm(String userId, GlossaryTerm glossaryTerm)` Create new glossaryTerm.
`GovernanceControl`	`createGovernanceControl(String userId, GovernanceControl governanceControl)` Create new governanceControl.
`GovernanceControlLink`	`createGovernanceControlLinkRelationship(String userId, GovernanceControlLink relationship)` Create GovernanceControlLink relationship
`GovernanceDefinition`	`createGovernanceDefinition(String userId, GovernanceDefinition governanceDefinition)` Create new governanceDefinition.
`GovernanceDefinitionMetric`	`createGovernanceDefinitionMetricRelationship(String userId, GovernanceDefinitionMetric relationship)` Create GovernanceDefinitionMetric relationship
`GovernanceDriver`	`createGovernanceDriver(String userId, GovernanceDriver governanceDriver)` Create new governanceDriver.
`GovernanceImplementation`	`createGovernanceImplementationRelationship(String userId, GovernanceImplementation relationship)` Create GovernanceImplementation relationship
`GovernanceMetric`	`createGovernanceMetric(String userId, GovernanceMetric governanceMetric)` Create new governanceMetric.
`GovernancePolicy`	`createGovernancePolicy(String userId, GovernancePolicy governancePolicy)` Create new governancePolicy.
`GovernancePolicyLink`	`createGovernancePolicyLinkRelationship(String userId, GovernancePolicyLink relationship)` Create GovernancePolicyLink relationship
`GovernanceProcess`	`createGovernanceProcess(String userId, GovernanceProcess governanceProcess)` Create new governanceProcess.
`GovernanceProcessImplementation`	`createGovernanceProcessImplementationRelationship(String userId, GovernanceProcessImplementation relationship)` Create GovernanceProcessImplementation relationship
`GovernanceResponse`	`createGovernanceResponseRelationship(String userId, GovernanceResponse relationship)` Create GovernanceResponse relationship
`GovernanceResponsibility`	`createGovernanceResponsibility(String userId, GovernanceResponsibility governanceResponsibility)` Create new governanceResponsibility.
`GovernanceResults`	`createGovernanceResultsRelationship(String userId, GovernanceResults relationship)` Create GovernanceResults relationship
`GovernanceRule`	`createGovernanceRule(String userId, GovernanceRule governanceRule)` Create new governanceRule.
`GovernanceRuleImplementation`	`createGovernanceRuleImplementationRelationship(String userId, GovernanceRuleImplementation relationship)` Create GovernanceRuleImplementation relationship
`GovernanceZone`	`createGovernanceZone(String userId, GovernanceZone governanceZone)` Create new governanceZone.
`GraphEdge`	`createGraphEdge(String userId, GraphEdge graphEdge)` Create new graphEdge.
`GraphEdgeLink`	`createGraphEdgeLinkRelationship(String userId, GraphEdgeLink relationship)` Create GraphEdgeLink relationship
`GraphVertex`	`createGraphVertex(String userId, GraphVertex graphVertex)` Create new graphVertex.
`GroupedMedia`	`createGroupedMediaRelationship(String userId, GroupedMedia relationship)` Create GroupedMedia relationship
`Host`	`createHost(String userId, Host host)` Create new host.
`HostCluster`	`createHostCluster(String userId, HostCluster hostCluster)` Create new hostCluster.
`HostClusterMember`	`createHostClusterMemberRelationship(String userId, HostClusterMember relationship)` Create HostClusterMember relationship
`HostLocation`	`createHostLocationRelationship(String userId, HostLocation relationship)` Create HostLocation relationship
`HostNetwork`	`createHostNetworkRelationship(String userId, HostNetwork relationship)` Create HostNetwork relationship
`HostOperatingPlatform`	`createHostOperatingPlatformRelationship(String userId, HostOperatingPlatform relationship)` Create HostOperatingPlatform relationship
`ImplementationSnippet`	`createImplementationSnippet(String userId, ImplementationSnippet implementationSnippet)` Create new implementationSnippet.
`InformalTag`	`createInformalTag(String userId, InformalTag informalTag)` Create new informalTag.
`ISARelationship`	`createISARelationshipRelationship(String userId, ISARelationship relationship)` Create ISARelationship relationship
`LibraryCategoryReference`	`createLibraryCategoryReferenceRelationship(String userId, LibraryCategoryReference relationship)` Create LibraryCategoryReference relationship
`LibraryTermReference`	`createLibraryTermReferenceRelationship(String userId, LibraryTermReference relationship)` Create LibraryTermReference relationship
`License`	`createLicenseRelationship(String userId, License relationship)` Create License relationship
`LicenseType`	`createLicenseType(String userId, LicenseType licenseType)` Create new licenseType.
`Like`	`createLike(String userId, Like like)` Create new like.
`LinkedFile`	`createLinkedFileRelationship(String userId, LinkedFile relationship)` Create LinkedFile relationship
`LinkedMedia`	`createLinkedMediaRelationship(String userId, LinkedMedia relationship)` Create LinkedMedia relationship
`LinkedType`	`createLinkedTypeRelationship(String userId, LinkedType relationship)` Create LinkedType relationship
`Location`	`createLocation(String userId, Location location)` Create new location.
`MapFromElementType`	`createMapFromElementTypeRelationship(String userId, MapFromElementType relationship)` Create MapFromElementType relationship
`MapSchemaType`	`createMapSchemaType(String userId, MapSchemaType mapSchemaType)` Create new mapSchemaType.
`MapToElementType`	`createMapToElementTypeRelationship(String userId, MapToElementType relationship)` Create MapToElementType relationship
`MediaCollection`	`createMediaCollection(String userId, MediaCollection mediaCollection)` Create new mediaCollection.
`MediaFile`	`createMediaFile(String userId, MediaFile mediaFile)` Create new mediaFile.
`MediaReference`	`createMediaReferenceRelationship(String userId, MediaReference relationship)` Create MediaReference relationship
`Meeting`	`createMeeting(String userId, Meeting meeting)` Create new meeting.
`MetadataCohortPeer`	`createMetadataCohortPeerRelationship(String userId, MetadataCohortPeer relationship)` Create MetadataCohortPeer relationship
`MetadataCollection`	`createMetadataCollection(String userId, MetadataCollection metadataCollection)` Create new metadataCollection.
`MetadataRepositoryCohort`	`createMetadataRepositoryCohort(String userId, MetadataRepositoryCohort metadataRepositoryCohort)` Create new metadataRepositoryCohort.
`NestedFile`	`createNestedFileRelationship(String userId, NestedFile relationship)` Create NestedFile relationship
`NestedLocation`	`createNestedLocationRelationship(String userId, NestedLocation relationship)` Create NestedLocation relationship
`Network`	`createNetwork(String userId, Network network)` Create new network.
`NetworkGateway`	`createNetworkGateway(String userId, NetworkGateway networkGateway)` Create new networkGateway.
`NetworkGatewayLink`	`createNetworkGatewayLinkRelationship(String userId, NetworkGatewayLink relationship)` Create NetworkGatewayLink relationship
`NoteEntry`	`createNoteEntry(String userId, NoteEntry noteEntry)` Create new noteEntry.
`NoteLog`	`createNoteLog(String userId, NoteLog noteLog)` Create new noteLog.
`OperatingPlatform`	`createOperatingPlatform(String userId, OperatingPlatform operatingPlatform)` Create new operatingPlatform.
`OrganizationalCapability`	`createOrganizationalCapabilityRelationship(String userId, OrganizationalCapability relationship)` Create OrganizationalCapability relationship
`Peer`	`createPeerRelationship(String userId, Peer relationship)` Create Peer relationship
`Person`	`createPerson(String userId, Person person)` Create new person.
`PreferredTerm`	`createPreferredTermRelationship(String userId, PreferredTerm relationship)` Create PreferredTerm relationship
`Process`	`createProcess(String userId, Process process)` Create new process.
`ProcessInput`	`createProcessInputRelationship(String userId, ProcessInput relationship)` Create ProcessInput relationship
`ProcessOutput`	`createProcessOutputRelationship(String userId, ProcessOutput relationship)` Create ProcessOutput relationship
`ProfileIdentity`	`createProfileIdentityRelationship(String userId, ProfileIdentity relationship)` Create ProfileIdentity relationship
`Project`	`createProject(String userId, Project project)` Create new project.
`ProjectCharter`	`createProjectCharter(String userId, ProjectCharter projectCharter)` Create new projectCharter.
`ProjectCharterLink`	`createProjectCharterLinkRelationship(String userId, ProjectCharterLink relationship)` Create ProjectCharterLink relationship
`ProjectDependency`	`createProjectDependencyRelationship(String userId, ProjectDependency relationship)` Create ProjectDependency relationship
`ProjectHierarchy`	`createProjectHierarchyRelationship(String userId, ProjectHierarchy relationship)` Create ProjectHierarchy relationship
`ProjectScope`	`createProjectScopeRelationship(String userId, ProjectScope relationship)` Create ProjectScope relationship
`ProjectTeam`	`createProjectTeamRelationship(String userId, ProjectTeam relationship)` Create ProjectTeam relationship
`PropertyFacet`	`createPropertyFacet(String userId, PropertyFacet propertyFacet)` Create new propertyFacet.
`Rating`	`createRating(String userId, Rating rating)` Create new rating.
`Referenceable`	`createReferenceable(String userId, Referenceable referenceable)` Create new referenceable.
`ReferenceableFacet`	`createReferenceableFacetRelationship(String userId, ReferenceableFacet relationship)` Create ReferenceableFacet relationship
`Regulation`	`createRegulation(String userId, Regulation regulation)` Create new regulation.
`RegulationCertificationType`	`createRegulationCertificationTypeRelationship(String userId, RegulationCertificationType relationship)` Create RegulationCertificationType relationship
`RelatedMedia`	`createRelatedMedia(String userId, RelatedMedia relatedMedia)` Create new relatedMedia.
`RelatedTerm`	`createRelatedTermRelationship(String userId, RelatedTerm relationship)` Create RelatedTerm relationship
`ReplacementTerm`	`createReplacementTermRelationship(String userId, ReplacementTerm relationship)` Create ReplacementTerm relationship
`ResponsibilityStaffContact`	`createResponsibilityStaffContactRelationship(String userId, ResponsibilityStaffContact relationship)` Create ResponsibilityStaffContact relationship
`RuntimeForProcess`	`createRuntimeForProcessRelationship(String userId, RuntimeForProcess relationship)` Create RuntimeForProcess relationship
`SchemaAttribute`	`createSchemaAttribute(String userId, SchemaAttribute schemaAttribute)` Create new schemaAttribute.
`SchemaAttributeType`	`createSchemaAttributeTypeRelationship(String userId, SchemaAttributeType relationship)` Create SchemaAttributeType relationship
`SchemaLinkElement`	`createSchemaLinkElement(String userId, SchemaLinkElement schemaLinkElement)` Create new schemaLinkElement.
`SchemaLinkToType`	`createSchemaLinkToTypeRelationship(String userId, SchemaLinkToType relationship)` Create SchemaLinkToType relationship
`SchemaQueryImplementation`	`createSchemaQueryImplementationRelationship(String userId, SchemaQueryImplementation relationship)` Create SchemaQueryImplementation relationship
`SchemaType`	`createSchemaType(String userId, SchemaType schemaType)` Create new schemaType.
`SchemaTypeImplementation`	`createSchemaTypeImplementationRelationship(String userId, SchemaTypeImplementation relationship)` Create SchemaTypeImplementation relationship
`SemanticAssignment`	`createSemanticAssignmentRelationship(String userId, SemanticAssignment relationship)` Create SemanticAssignment relationship
`ServerEndpoint`	`createServerEndpointRelationship(String userId, ServerEndpoint relationship)` Create ServerEndpoint relationship
`SoftwareServer`	`createSoftwareServer(String userId, SoftwareServer softwareServer)` Create new softwareServer.
`SoftwareServerCapability`	`createSoftwareServerCapability(String userId, SoftwareServerCapability softwareServerCapability)` Create new softwareServerCapability.
`SoftwareServerPlatform`	`createSoftwareServerPlatform(String userId, SoftwareServerPlatform softwareServerPlatform)` Create new softwareServerPlatform.
`SubscriberList`	`createSubscriberList(String userId, SubscriberList subscriberList)` Create new subscriberList.
`Synonym`	`createSynonymRelationship(String userId, Synonym relationship)` Create Synonym relationship
`Team`	`createTeam(String userId, Team team)` Create new team.
`TermAnchor`	`createTermAnchorRelationship(String userId, TermAnchor relationship)` Create TermAnchor relationship
`TermCategorization`	`createTermCategorizationRelationship(String userId, TermCategorization relationship)` Create TermCategorization relationship
`TermHASARelationship`	`createTermHASARelationshipRelationship(String userId, TermHASARelationship relationship)` Create TermHASARelationship relationship
`TermISATypeOFRelationship`	`createTermISATypeOFRelationshipRelationship(String userId, TermISATypeOFRelationship relationship)` Create TermISATypeOFRelationship relationship
`TermTYPEDBYRelationship`	`createTermTYPEDBYRelationshipRelationship(String userId, TermTYPEDBYRelationship relationship)` Create TermTYPEDBYRelationship relationship
`ToDo`	`createToDo(String userId, ToDo toDo)` Create new toDo.
`ToDoSource`	`createToDoSourceRelationship(String userId, ToDoSource relationship)` Create ToDoSource relationship
`Topic`	`createTopic(String userId, Topic topic)` Create new topic.
`TopicSubscribers`	`createTopicSubscribersRelationship(String userId, TopicSubscribers relationship)` Create TopicSubscribers relationship
`Translation`	`createTranslationRelationship(String userId, Translation relationship)` Create Translation relationship
`UsedInContext`	`createUsedInContextRelationship(String userId, UsedInContext relationship)` Create UsedInContext relationship
`UserIdentity`	`createUserIdentity(String userId, UserIdentity userIdentity)` Create new userIdentity.
`ValidValue`	`createValidValueRelationship(String userId, ValidValue relationship)` Create ValidValue relationship
`VirtualConnection`	`createVirtualConnection(String userId, VirtualConnection virtualConnection)` Create new virtualConnection.
`VirtualContainer`	`createVirtualContainer(String userId, VirtualContainer virtualContainer)` Create new virtualContainer.
`ZoneGovernance`	`createZoneGovernanceRelationship(String userId, ZoneGovernance relationship)` Create ZoneGovernance relationship
`EntityDetail`	`deleteActorProfileByGuid(String userId, String entityGuid)` Delete an actorProfile identified by its GUID.
`ActorProfile`	`deleteActorProfileClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing actorProfile represented by a guid.
`EntityDetail`	`deleteAPIOperationByGuid(String userId, String entityGuid)` Delete an aPIOperation identified by its GUID.
`APIOperation`	`deleteAPIOperationClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing aPIOperation represented by a guid.
`EntityDetail`	`deleteAPISchemaTypeByGuid(String userId, String entityGuid)` Delete an aPISchemaType identified by its GUID.
`APISchemaType`	`deleteAPISchemaTypeClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing aPISchemaType represented by a guid.
`EntityDetail`	`deleteApplicationByGuid(String userId, String entityGuid)` Delete an application identified by its GUID.
`Application`	`deleteApplicationClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing application represented by a guid.
`EntityDetail`	`deleteAssetByGuid(String userId, String entityGuid)` Delete an asset identified by its GUID.
`Asset`	`deleteAssetClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing asset represented by a guid.
`EntityDetail`	`deleteBusinessCapabilityByGuid(String userId, String entityGuid)` Delete an businessCapability identified by its GUID.
`BusinessCapability`	`deleteBusinessCapabilityClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing businessCapability represented by a guid.
`EntityDetail`	`deleteCertificationTypeByGuid(String userId, String entityGuid)` Delete an certificationType identified by its GUID.
`CertificationType`	`deleteCertificationTypeClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing certificationType represented by a guid.
`EntityDetail`	`deleteCohortMemberByGuid(String userId, String entityGuid)` Delete an cohortMember identified by its GUID.
`CohortMember`	`deleteCohortMemberClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing cohortMember represented by a guid.
`EntityDetail`	`deleteCollectionByGuid(String userId, String entityGuid)` Delete an collection identified by its GUID.
`Collection`	`deleteCollectionClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing collection represented by a guid.
`EntityDetail`	`deleteCommentByGuid(String userId, String entityGuid)` Delete an comment identified by its GUID.
`Comment`	`deleteCommentClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing comment represented by a guid.
`EntityDetail`	`deleteCommunityByGuid(String userId, String entityGuid)` Delete an community identified by its GUID.
`Community`	`deleteCommunityClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing community represented by a guid.
`EntityDetail`	`deleteCommunityMemberByGuid(String userId, String entityGuid)` Delete an communityMember identified by its GUID.
`CommunityMember`	`deleteCommunityMemberClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing communityMember represented by a guid.
`EntityDetail`	`deleteComplexSchemaTypeByGuid(String userId, String entityGuid)` Delete an complexSchemaType identified by its GUID.
`ComplexSchemaType`	`deleteComplexSchemaTypeClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing complexSchemaType represented by a guid.
`EntityDetail`	`deleteConnectionByGuid(String userId, String entityGuid)` Delete an connection identified by its GUID.
`Connection`	`deleteConnectionClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing connection represented by a guid.
`EntityDetail`	`deleteConnectorTypeByGuid(String userId, String entityGuid)` Delete an connectorType identified by its GUID.
`ConnectorType`	`deleteConnectorTypeClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing connectorType represented by a guid.
`EntityDetail`	`deleteContactDetailsByGuid(String userId, String entityGuid)` Delete an contactDetails identified by its GUID.
`ContactDetails`	`deleteContactDetailsClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing contactDetails represented by a guid.
`EntityDetail`	`deleteDataFileByGuid(String userId, String entityGuid)` Delete an dataFile identified by its GUID.
`DataFile`	`deleteDataFileClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing dataFile represented by a guid.
`EntityDetail`	`deleteDataSetByGuid(String userId, String entityGuid)` Delete an dataSet identified by its GUID.
`DataSet`	`deleteDataSetClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing dataSet represented by a guid.
`EntityDetail`	`deleteDeployedAPIByGuid(String userId, String entityGuid)` Delete an deployedAPI identified by its GUID.
`DeployedAPI`	`deleteDeployedAPIClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing deployedAPI represented by a guid.
`EntityDetail`	`deleteDeployedSoftwareComponentByGuid(String userId, String entityGuid)` Delete an deployedSoftwareComponent identified by its GUID.
`DeployedSoftwareComponent`	`deleteDeployedSoftwareComponentClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing deployedSoftwareComponent represented by a guid.
`EntityDetail`	`deleteDerivedSchemaAttributeByGuid(String userId, String entityGuid)` Delete an derivedSchemaAttribute identified by its GUID.
`DerivedSchemaAttribute`	`deleteDerivedSchemaAttributeClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing derivedSchemaAttribute represented by a guid.
`EntityDetail`	`deleteEndpointByGuid(String userId, String entityGuid)` Delete an endpoint identified by its GUID.
`Endpoint`	`deleteEndpointClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing endpoint represented by a guid.
`EntityDetail`	`deleteExternalGlossaryLinkByGuid(String userId, String entityGuid)` Delete an externalGlossaryLink identified by its GUID.
`ExternalGlossaryLink`	`deleteExternalGlossaryLinkClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing externalGlossaryLink represented by a guid.
`EntityDetail`	`deleteExternalIdByGuid(String userId, String entityGuid)` Delete an externalId identified by its GUID.
`ExternalId`	`deleteExternalIdClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing externalId represented by a guid.
`EntityDetail`	`deleteExternalReferenceByGuid(String userId, String entityGuid)` Delete an externalReference identified by its GUID.
`ExternalReference`	`deleteExternalReferenceClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing externalReference represented by a guid.
`EntityDetail`	`deleteFileFolderByGuid(String userId, String entityGuid)` Delete an fileFolder identified by its GUID.
`FileFolder`	`deleteFileFolderClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing fileFolder represented by a guid.
`EntityDetail`	`deleteGlossaryByGuid(String userId, String entityGuid)` Delete an glossary identified by its GUID.
`EntityDetail`	`deleteGlossaryCategoryByGuid(String userId, String entityGuid)` Delete an glossaryCategory identified by its GUID.
`GlossaryCategory`	`deleteGlossaryCategoryClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing glossaryCategory represented by a guid.
`Glossary`	`deleteGlossaryClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing glossary represented by a guid.
`EntityDetail`	`deleteGlossaryTermByGuid(String userId, String entityGuid)` Delete an glossaryTerm identified by its GUID.
`GlossaryTerm`	`deleteGlossaryTermClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing glossaryTerm represented by a guid.
`EntityDetail`	`deleteGovernanceControlByGuid(String userId, String entityGuid)` Delete an governanceControl identified by its GUID.
`GovernanceControl`	`deleteGovernanceControlClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing governanceControl represented by a guid.
`EntityDetail`	`deleteGovernanceDefinitionByGuid(String userId, String entityGuid)` Delete an governanceDefinition identified by its GUID.
`GovernanceDefinition`	`deleteGovernanceDefinitionClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing governanceDefinition represented by a guid.
`EntityDetail`	`deleteGovernanceDriverByGuid(String userId, String entityGuid)` Delete an governanceDriver identified by its GUID.
`GovernanceDriver`	`deleteGovernanceDriverClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing governanceDriver represented by a guid.
`EntityDetail`	`deleteGovernanceMetricByGuid(String userId, String entityGuid)` Delete an governanceMetric identified by its GUID.
`GovernanceMetric`	`deleteGovernanceMetricClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing governanceMetric represented by a guid.
`EntityDetail`	`deleteGovernancePolicyByGuid(String userId, String entityGuid)` Delete an governancePolicy identified by its GUID.
`GovernancePolicy`	`deleteGovernancePolicyClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing governancePolicy represented by a guid.
`EntityDetail`	`deleteGovernanceProcessByGuid(String userId, String entityGuid)` Delete an governanceProcess identified by its GUID.
`GovernanceProcess`	`deleteGovernanceProcessClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing governanceProcess represented by a guid.
`EntityDetail`	`deleteGovernanceResponsibilityByGuid(String userId, String entityGuid)` Delete an governanceResponsibility identified by its GUID.
`GovernanceResponsibility`	`deleteGovernanceResponsibilityClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing governanceResponsibility represented by a guid.
`EntityDetail`	`deleteGovernanceRuleByGuid(String userId, String entityGuid)` Delete an governanceRule identified by its GUID.
`GovernanceRule`	`deleteGovernanceRuleClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing governanceRule represented by a guid.
`EntityDetail`	`deleteGovernanceZoneByGuid(String userId, String entityGuid)` Delete an governanceZone identified by its GUID.
`GovernanceZone`	`deleteGovernanceZoneClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing governanceZone represented by a guid.
`EntityDetail`	`deleteGraphEdgeByGuid(String userId, String entityGuid)` Delete an graphEdge identified by its GUID.
`GraphEdge`	`deleteGraphEdgeClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing graphEdge represented by a guid.
`EntityDetail`	`deleteGraphVertexByGuid(String userId, String entityGuid)` Delete an graphVertex identified by its GUID.
`GraphVertex`	`deleteGraphVertexClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing graphVertex represented by a guid.
`EntityDetail`	`deleteHostByGuid(String userId, String entityGuid)` Delete an host identified by its GUID.
`Host`	`deleteHostClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing host represented by a guid.
`EntityDetail`	`deleteHostClusterByGuid(String userId, String entityGuid)` Delete an hostCluster identified by its GUID.
`HostCluster`	`deleteHostClusterClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing hostCluster represented by a guid.
`EntityDetail`	`deleteImplementationSnippetByGuid(String userId, String entityGuid)` Delete an implementationSnippet identified by its GUID.
`ImplementationSnippet`	`deleteImplementationSnippetClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing implementationSnippet represented by a guid.
`EntityDetail`	`deleteInformalTagByGuid(String userId, String entityGuid)` Delete an informalTag identified by its GUID.
`InformalTag`	`deleteInformalTagClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing informalTag represented by a guid.
`EntityDetail`	`deleteLicenseTypeByGuid(String userId, String entityGuid)` Delete an licenseType identified by its GUID.
`LicenseType`	`deleteLicenseTypeClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing licenseType represented by a guid.
`EntityDetail`	`deleteLikeByGuid(String userId, String entityGuid)` Delete an like identified by its GUID.
`Like`	`deleteLikeClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing like represented by a guid.
`EntityDetail`	`deleteLocationByGuid(String userId, String entityGuid)` Delete an location identified by its GUID.
`Location`	`deleteLocationClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing location represented by a guid.
`EntityDetail`	`deleteMapSchemaTypeByGuid(String userId, String entityGuid)` Delete an mapSchemaType identified by its GUID.
`MapSchemaType`	`deleteMapSchemaTypeClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing mapSchemaType represented by a guid.
`EntityDetail`	`deleteMediaCollectionByGuid(String userId, String entityGuid)` Delete an mediaCollection identified by its GUID.
`MediaCollection`	`deleteMediaCollectionClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing mediaCollection represented by a guid.
`EntityDetail`	`deleteMediaFileByGuid(String userId, String entityGuid)` Delete an mediaFile identified by its GUID.
`MediaFile`	`deleteMediaFileClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing mediaFile represented by a guid.
`EntityDetail`	`deleteMeetingByGuid(String userId, String entityGuid)` Delete an meeting identified by its GUID.
`Meeting`	`deleteMeetingClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing meeting represented by a guid.
`EntityDetail`	`deleteMetadataCollectionByGuid(String userId, String entityGuid)` Delete an metadataCollection identified by its GUID.
`MetadataCollection`	`deleteMetadataCollectionClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing metadataCollection represented by a guid.
`EntityDetail`	`deleteMetadataRepositoryCohortByGuid(String userId, String entityGuid)` Delete an metadataRepositoryCohort identified by its GUID.
`MetadataRepositoryCohort`	`deleteMetadataRepositoryCohortClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing metadataRepositoryCohort represented by a guid.
`EntityDetail`	`deleteNetworkByGuid(String userId, String entityGuid)` Delete an network identified by its GUID.
`Network`	`deleteNetworkClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing network represented by a guid.
`EntityDetail`	`deleteNetworkGatewayByGuid(String userId, String entityGuid)` Delete an networkGateway identified by its GUID.
`NetworkGateway`	`deleteNetworkGatewayClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing networkGateway represented by a guid.
`EntityDetail`	`deleteNoteEntryByGuid(String userId, String entityGuid)` Delete an noteEntry identified by its GUID.
`NoteEntry`	`deleteNoteEntryClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing noteEntry represented by a guid.
`EntityDetail`	`deleteNoteLogByGuid(String userId, String entityGuid)` Delete an noteLog identified by its GUID.
`NoteLog`	`deleteNoteLogClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing noteLog represented by a guid.
`EntityDetail`	`deleteOperatingPlatformByGuid(String userId, String entityGuid)` Delete an operatingPlatform identified by its GUID.
`OperatingPlatform`	`deleteOperatingPlatformClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing operatingPlatform represented by a guid.
`EntityDetail`	`deletePersonByGuid(String userId, String entityGuid)` Delete an person identified by its GUID.
`Person`	`deletePersonClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing person represented by a guid.
`EntityDetail`	`deleteProcessByGuid(String userId, String entityGuid)` Delete an process identified by its GUID.
`Process`	`deleteProcessClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing process represented by a guid.
`EntityDetail`	`deleteProjectByGuid(String userId, String entityGuid)` Delete an project identified by its GUID.
`EntityDetail`	`deleteProjectCharterByGuid(String userId, String entityGuid)` Delete an projectCharter identified by its GUID.
`ProjectCharter`	`deleteProjectCharterClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing projectCharter represented by a guid.
`Project`	`deleteProjectClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing project represented by a guid.
`EntityDetail`	`deletePropertyFacetByGuid(String userId, String entityGuid)` Delete an propertyFacet identified by its GUID.
`PropertyFacet`	`deletePropertyFacetClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing propertyFacet represented by a guid.
`EntityDetail`	`deleteRatingByGuid(String userId, String entityGuid)` Delete an rating identified by its GUID.
`Rating`	`deleteRatingClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing rating represented by a guid.
`EntityDetail`	`deleteReferenceableByGuid(String userId, String entityGuid)` Delete an referenceable identified by its GUID.
`Referenceable`	`deleteReferenceableClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing referenceable represented by a guid.
`EntityDetail`	`deleteRegulationByGuid(String userId, String entityGuid)` Delete an regulation identified by its GUID.
`Regulation`	`deleteRegulationClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing regulation represented by a guid.
`EntityDetail`	`deleteRelatedMediaByGuid(String userId, String entityGuid)` Delete an relatedMedia identified by its GUID.
`RelatedMedia`	`deleteRelatedMediaClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing relatedMedia represented by a guid.
`Relationship`	`deleteRelationshipById(String userId, String relationshipGuid, String typeName)` Delete relationship.
`EntityDetail`	`deleteSchemaAttributeByGuid(String userId, String entityGuid)` Delete an schemaAttribute identified by its GUID.
`SchemaAttribute`	`deleteSchemaAttributeClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing schemaAttribute represented by a guid.
`EntityDetail`	`deleteSchemaLinkElementByGuid(String userId, String entityGuid)` Delete an schemaLinkElement identified by its GUID.
`SchemaLinkElement`	`deleteSchemaLinkElementClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing schemaLinkElement represented by a guid.
`EntityDetail`	`deleteSchemaTypeByGuid(String userId, String entityGuid)` Delete an schemaType identified by its GUID.
`SchemaType`	`deleteSchemaTypeClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing schemaType represented by a guid.
`EntityDetail`	`deleteSoftwareServerByGuid(String userId, String entityGuid)` Delete an softwareServer identified by its GUID.
`EntityDetail`	`deleteSoftwareServerCapabilityByGuid(String userId, String entityGuid)` Delete an softwareServerCapability identified by its GUID.
`SoftwareServerCapability`	`deleteSoftwareServerCapabilityClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing softwareServerCapability represented by a guid.
`SoftwareServer`	`deleteSoftwareServerClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing softwareServer represented by a guid.
`EntityDetail`	`deleteSoftwareServerPlatformByGuid(String userId, String entityGuid)` Delete an softwareServerPlatform identified by its GUID.
`SoftwareServerPlatform`	`deleteSoftwareServerPlatformClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing softwareServerPlatform represented by a guid.
`EntityDetail`	`deleteSubscriberListByGuid(String userId, String entityGuid)` Delete an subscriberList identified by its GUID.
`SubscriberList`	`deleteSubscriberListClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing subscriberList represented by a guid.
`EntityDetail`	`deleteTeamByGuid(String userId, String entityGuid)` Delete an team identified by its GUID.
`Team`	`deleteTeamClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing team represented by a guid.
`EntityDetail`	`deleteToDoByGuid(String userId, String entityGuid)` Delete an toDo identified by its GUID.
`ToDo`	`deleteToDoClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing toDo represented by a guid.
`EntityDetail`	`deleteTopicByGuid(String userId, String entityGuid)` Delete an topic identified by its GUID.
`Topic`	`deleteTopicClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing topic represented by a guid.
`EntityDetail`	`deleteUserIdentityByGuid(String userId, String entityGuid)` Delete an userIdentity identified by its GUID.
`UserIdentity`	`deleteUserIdentityClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing userIdentity represented by a guid.
`EntityDetail`	`deleteVirtualConnectionByGuid(String userId, String entityGuid)` Delete an virtualConnection identified by its GUID.
`VirtualConnection`	`deleteVirtualConnectionClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing virtualConnection represented by a guid.
`EntityDetail`	`deleteVirtualContainerByGuid(String userId, String entityGuid)` Delete an virtualContainer identified by its GUID.
`VirtualContainer`	`deleteVirtualContainerClassification(String userId, String entityGuid, String name)` Deletes a given classification from an existing virtualContainer represented by a guid.
`AcceptedAnswer`	`getAcceptedAnswerRelationshipByGuid(String userId, String relationshipGuid)` Get AcceptedAnswer relationship
`ActorProfile`	`getActorProfileById(String userId, String entityGuid)` Fetch complete definition of an actorProfile given its GUID.
`Set<Line>`	`getActorProfileRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity actorProfile represented by a guid.
`AdjacentLocation`	`getAdjacentLocationRelationshipByGuid(String userId, String relationshipGuid)` Get AdjacentLocation relationship
`Antonym`	`getAntonymRelationshipByGuid(String userId, String relationshipGuid)` Get Antonym relationship
`APIEndpoint`	`getAPIEndpointRelationshipByGuid(String userId, String relationshipGuid)` Get APIEndpoint relationship
`APIHeader`	`getAPIHeaderRelationshipByGuid(String userId, String relationshipGuid)` Get APIHeader relationship
`APIOperation`	`getAPIOperationById(String userId, String entityGuid)` Fetch complete definition of an aPIOperation given its GUID.
`Set<Line>`	`getAPIOperationRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity aPIOperation represented by a guid.
`APIOperations`	`getAPIOperationsRelationshipByGuid(String userId, String relationshipGuid)` Get APIOperations relationship
`APIRequest`	`getAPIRequestRelationshipByGuid(String userId, String relationshipGuid)` Get APIRequest relationship
`APIResponse`	`getAPIResponseRelationshipByGuid(String userId, String relationshipGuid)` Get APIResponse relationship
`APISchemaType`	`getAPISchemaTypeById(String userId, String entityGuid)` Fetch complete definition of an aPISchemaType given its GUID.
`Set<Line>`	`getAPISchemaTypeRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity aPISchemaType represented by a guid.
`Application`	`getApplicationById(String userId, String entityGuid)` Fetch complete definition of an application given its GUID.
`Set<Line>`	`getApplicationRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity application represented by a guid.
`Asset`	`getAssetById(String userId, String entityGuid)` Fetch complete definition of an asset given its GUID.
`AssetLocation`	`getAssetLocationRelationshipByGuid(String userId, String relationshipGuid)` Get AssetLocation relationship
`Set<Line>`	`getAssetRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity asset represented by a guid.
`AssetSchemaType`	`getAssetSchemaTypeRelationshipByGuid(String userId, String relationshipGuid)` Get AssetSchemaType relationship
`AssetServerUse`	`getAssetServerUseRelationshipByGuid(String userId, String relationshipGuid)` Get AssetServerUse relationship
`AttachedComment`	`getAttachedCommentRelationshipByGuid(String userId, String relationshipGuid)` Get AttachedComment relationship
`AttachedLike`	`getAttachedLikeRelationshipByGuid(String userId, String relationshipGuid)` Get AttachedLike relationship
`AttachedNoteLogEntry`	`getAttachedNoteLogEntryRelationshipByGuid(String userId, String relationshipGuid)` Get AttachedNoteLogEntry relationship
`AttachedNoteLog`	`getAttachedNoteLogRelationshipByGuid(String userId, String relationshipGuid)` Get AttachedNoteLog relationship
`AttachedRating`	`getAttachedRatingRelationshipByGuid(String userId, String relationshipGuid)` Get AttachedRating relationship
`AttachedTag`	`getAttachedTagRelationshipByGuid(String userId, String relationshipGuid)` Get AttachedTag relationship
`AttributeForSchema`	`getAttributeForSchemaRelationshipByGuid(String userId, String relationshipGuid)` Get AttributeForSchema relationship
`BusinessCapability`	`getBusinessCapabilityById(String userId, String entityGuid)` Fetch complete definition of an businessCapability given its GUID.
`Set<Line>`	`getBusinessCapabilityRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity businessCapability represented by a guid.
`CategoryAnchor`	`getCategoryAnchorRelationshipByGuid(String userId, String relationshipGuid)` Get CategoryAnchor relationship
`CategoryHierarchyLink`	`getCategoryHierarchyLinkRelationshipByGuid(String userId, String relationshipGuid)` Get CategoryHierarchyLink relationship
`Certification`	`getCertificationRelationshipByGuid(String userId, String relationshipGuid)` Get Certification relationship
`CertificationType`	`getCertificationTypeById(String userId, String entityGuid)` Fetch complete definition of an certificationType given its GUID.
`Set<Line>`	`getCertificationTypeRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity certificationType represented by a guid.
`CohortMember`	`getCohortMemberById(String userId, String entityGuid)` Fetch complete definition of an cohortMember given its GUID.
`CohortMemberMetadataCollection`	`getCohortMemberMetadataCollectionRelationshipByGuid(String userId, String relationshipGuid)` Get CohortMemberMetadataCollection relationship
`Set<Line>`	`getCohortMemberRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity cohortMember represented by a guid.
`Collection`	`getCollectionById(String userId, String entityGuid)` Fetch complete definition of an collection given its GUID.
`Set<Line>`	`getCollectionRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity collection represented by a guid.
`Comment`	`getCommentById(String userId, String entityGuid)` Fetch complete definition of an comment given its GUID.
`Set<Line>`	`getCommentRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity comment represented by a guid.
`Community`	`getCommunityById(String userId, String entityGuid)` Fetch complete definition of an community given its GUID.
`CommunityMember`	`getCommunityMemberById(String userId, String entityGuid)` Fetch complete definition of an communityMember given its GUID.
`Set<Line>`	`getCommunityMemberRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity communityMember represented by a guid.
`CommunityMembership`	`getCommunityMembershipRelationshipByGuid(String userId, String relationshipGuid)` Get CommunityMembership relationship
`Set<Line>`	`getCommunityRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity community represented by a guid.
`ComplexSchemaType`	`getComplexSchemaTypeById(String userId, String entityGuid)` Fetch complete definition of an complexSchemaType given its GUID.
`Set<Line>`	`getComplexSchemaTypeRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity complexSchemaType represented by a guid.
`Connection`	`getConnectionById(String userId, String entityGuid)` Fetch complete definition of an connection given its GUID.
`ConnectionConnectorType`	`getConnectionConnectorTypeRelationshipByGuid(String userId, String relationshipGuid)` Get ConnectionConnectorType relationship
`ConnectionEndpoint`	`getConnectionEndpointRelationshipByGuid(String userId, String relationshipGuid)` Get ConnectionEndpoint relationship
`Set<Line>`	`getConnectionRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity connection represented by a guid.
`ConnectionToAsset`	`getConnectionToAssetRelationshipByGuid(String userId, String relationshipGuid)` Get ConnectionToAsset relationship
`ConnectorType`	`getConnectorTypeById(String userId, String entityGuid)` Fetch complete definition of an connectorType given its GUID.
`Set<Line>`	`getConnectorTypeRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity connectorType represented by a guid.
`ContactDetails`	`getContactDetailsById(String userId, String entityGuid)` Fetch complete definition of an contactDetails given its GUID.
`Set<Line>`	`getContactDetailsRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity contactDetails represented by a guid.
`ContactThrough`	`getContactThroughRelationshipByGuid(String userId, String relationshipGuid)` Get ContactThrough relationship
`DataContentForDataSet`	`getDataContentForDataSetRelationshipByGuid(String userId, String relationshipGuid)` Get DataContentForDataSet relationship
`DataFile`	`getDataFileById(String userId, String entityGuid)` Fetch complete definition of an dataFile given its GUID.
`Set<Line>`	`getDataFileRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity dataFile represented by a guid.
`DataSet`	`getDataSetById(String userId, String entityGuid)` Fetch complete definition of an dataSet given its GUID.
`Set<Line>`	`getDataSetRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity dataSet represented by a guid.
`DeployedAPI`	`getDeployedAPIById(String userId, String entityGuid)` Fetch complete definition of an deployedAPI given its GUID.
`Set<Line>`	`getDeployedAPIRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity deployedAPI represented by a guid.
`DeployedSoftwareComponent`	`getDeployedSoftwareComponentById(String userId, String entityGuid)` Fetch complete definition of an deployedSoftwareComponent given its GUID.
`Set<Line>`	`getDeployedSoftwareComponentRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity deployedSoftwareComponent represented by a guid.
`DeployedVirtualContainer`	`getDeployedVirtualContainerRelationshipByGuid(String userId, String relationshipGuid)` Get DeployedVirtualContainer relationship
`DerivedSchemaAttribute`	`getDerivedSchemaAttributeById(String userId, String entityGuid)` Fetch complete definition of an derivedSchemaAttribute given its GUID.
`Set<Line>`	`getDerivedSchemaAttributeRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity derivedSchemaAttribute represented by a guid.
`EmbeddedConnection`	`getEmbeddedConnectionRelationshipByGuid(String userId, String relationshipGuid)` Get EmbeddedConnection relationship
`Endpoint`	`getEndpointById(String userId, String entityGuid)` Fetch complete definition of an endpoint given its GUID.
`Set<Line>`	`getEndpointRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity endpoint represented by a guid.
`ExternalGlossaryLink`	`getExternalGlossaryLinkById(String userId, String entityGuid)` Fetch complete definition of an externalGlossaryLink given its GUID.
`Set<Line>`	`getExternalGlossaryLinkRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity externalGlossaryLink represented by a guid.
`ExternalId`	`getExternalIdById(String userId, String entityGuid)` Fetch complete definition of an externalId given its GUID.
`ExternalIdLink`	`getExternalIdLinkRelationshipByGuid(String userId, String relationshipGuid)` Get ExternalIdLink relationship
`Set<Line>`	`getExternalIdRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity externalId represented by a guid.
`ExternalIdScope`	`getExternalIdScopeRelationshipByGuid(String userId, String relationshipGuid)` Get ExternalIdScope relationship
`ExternallySourcedGlossary`	`getExternallySourcedGlossaryRelationshipByGuid(String userId, String relationshipGuid)` Get ExternallySourcedGlossary relationship
`ExternalReference`	`getExternalReferenceById(String userId, String entityGuid)` Fetch complete definition of an externalReference given its GUID.
`ExternalReferenceLink`	`getExternalReferenceLinkRelationshipByGuid(String userId, String relationshipGuid)` Get ExternalReferenceLink relationship
`Set<Line>`	`getExternalReferenceRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity externalReference represented by a guid.
`FileFolder`	`getFileFolderById(String userId, String entityGuid)` Fetch complete definition of an fileFolder given its GUID.
`Set<Line>`	`getFileFolderRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity fileFolder represented by a guid.
`FolderHierarchy`	`getFolderHierarchyRelationshipByGuid(String userId, String relationshipGuid)` Get FolderHierarchy relationship
`Glossary`	`getGlossaryById(String userId, String entityGuid)` Fetch complete definition of an glossary given its GUID.
`GlossaryCategory`	`getGlossaryCategoryById(String userId, String entityGuid)` Fetch complete definition of an glossaryCategory given its GUID.
`Set<Line>`	`getGlossaryCategoryRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity glossaryCategory represented by a guid.
`Set<Line>`	`getGlossaryRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity glossary represented by a guid.
`GlossaryTerm`	`getGlossaryTermById(String userId, String entityGuid)` Fetch complete definition of an glossaryTerm given its GUID.
`Set<Line>`	`getGlossaryTermRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity glossaryTerm represented by a guid.
`GovernanceControl`	`getGovernanceControlById(String userId, String entityGuid)` Fetch complete definition of an governanceControl given its GUID.
`GovernanceControlLink`	`getGovernanceControlLinkRelationshipByGuid(String userId, String relationshipGuid)` Get GovernanceControlLink relationship
`Set<Line>`	`getGovernanceControlRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity governanceControl represented by a guid.
`GovernanceDefinition`	`getGovernanceDefinitionById(String userId, String entityGuid)` Fetch complete definition of an governanceDefinition given its GUID.
`GovernanceDefinitionMetric`	`getGovernanceDefinitionMetricRelationshipByGuid(String userId, String relationshipGuid)` Get GovernanceDefinitionMetric relationship
`Set<Line>`	`getGovernanceDefinitionRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity governanceDefinition represented by a guid.
`GovernanceDriver`	`getGovernanceDriverById(String userId, String entityGuid)` Fetch complete definition of an governanceDriver given its GUID.
`Set<Line>`	`getGovernanceDriverRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity governanceDriver represented by a guid.
`GovernanceImplementation`	`getGovernanceImplementationRelationshipByGuid(String userId, String relationshipGuid)` Get GovernanceImplementation relationship
`GovernanceMetric`	`getGovernanceMetricById(String userId, String entityGuid)` Fetch complete definition of an governanceMetric given its GUID.
`Set<Line>`	`getGovernanceMetricRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity governanceMetric represented by a guid.
`GovernancePolicy`	`getGovernancePolicyById(String userId, String entityGuid)` Fetch complete definition of an governancePolicy given its GUID.
`GovernancePolicyLink`	`getGovernancePolicyLinkRelationshipByGuid(String userId, String relationshipGuid)` Get GovernancePolicyLink relationship
`Set<Line>`	`getGovernancePolicyRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity governancePolicy represented by a guid.
`GovernanceProcess`	`getGovernanceProcessById(String userId, String entityGuid)` Fetch complete definition of an governanceProcess given its GUID.
`GovernanceProcessImplementation`	`getGovernanceProcessImplementationRelationshipByGuid(String userId, String relationshipGuid)` Get GovernanceProcessImplementation relationship
`Set<Line>`	`getGovernanceProcessRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity governanceProcess represented by a guid.
`GovernanceResponse`	`getGovernanceResponseRelationshipByGuid(String userId, String relationshipGuid)` Get GovernanceResponse relationship
`GovernanceResponsibility`	`getGovernanceResponsibilityById(String userId, String entityGuid)` Fetch complete definition of an governanceResponsibility given its GUID.
`Set<Line>`	`getGovernanceResponsibilityRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity governanceResponsibility represented by a guid.
`GovernanceResults`	`getGovernanceResultsRelationshipByGuid(String userId, String relationshipGuid)` Get GovernanceResults relationship
`GovernanceRule`	`getGovernanceRuleById(String userId, String entityGuid)` Fetch complete definition of an governanceRule given its GUID.
`GovernanceRuleImplementation`	`getGovernanceRuleImplementationRelationshipByGuid(String userId, String relationshipGuid)` Get GovernanceRuleImplementation relationship
`Set<Line>`	`getGovernanceRuleRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity governanceRule represented by a guid.
`GovernanceZone`	`getGovernanceZoneById(String userId, String entityGuid)` Fetch complete definition of an governanceZone given its GUID.
`Set<Line>`	`getGovernanceZoneRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity governanceZone represented by a guid.
`GraphEdge`	`getGraphEdgeById(String userId, String entityGuid)` Fetch complete definition of an graphEdge given its GUID.
`GraphEdgeLink`	`getGraphEdgeLinkRelationshipByGuid(String userId, String relationshipGuid)` Get GraphEdgeLink relationship
`Set<Line>`	`getGraphEdgeRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity graphEdge represented by a guid.
`GraphVertex`	`getGraphVertexById(String userId, String entityGuid)` Fetch complete definition of an graphVertex given its GUID.
`Set<Line>`	`getGraphVertexRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity graphVertex represented by a guid.
`GroupedMedia`	`getGroupedMediaRelationshipByGuid(String userId, String relationshipGuid)` Get GroupedMedia relationship
`Host`	`getHostById(String userId, String entityGuid)` Fetch complete definition of an host given its GUID.
`HostCluster`	`getHostClusterById(String userId, String entityGuid)` Fetch complete definition of an hostCluster given its GUID.
`HostClusterMember`	`getHostClusterMemberRelationshipByGuid(String userId, String relationshipGuid)` Get HostClusterMember relationship
`Set<Line>`	`getHostClusterRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity hostCluster represented by a guid.
`HostLocation`	`getHostLocationRelationshipByGuid(String userId, String relationshipGuid)` Get HostLocation relationship
`HostNetwork`	`getHostNetworkRelationshipByGuid(String userId, String relationshipGuid)` Get HostNetwork relationship
`HostOperatingPlatform`	`getHostOperatingPlatformRelationshipByGuid(String userId, String relationshipGuid)` Get HostOperatingPlatform relationship
`Set<Line>`	`getHostRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity host represented by a guid.
`ImplementationSnippet`	`getImplementationSnippetById(String userId, String entityGuid)` Fetch complete definition of an implementationSnippet given its GUID.
`Set<Line>`	`getImplementationSnippetRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity implementationSnippet represented by a guid.
`InformalTag`	`getInformalTagById(String userId, String entityGuid)` Fetch complete definition of an informalTag given its GUID.
`Set<Line>`	`getInformalTagRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity informalTag represented by a guid.
`ISARelationship`	`getISARelationshipRelationshipByGuid(String userId, String relationshipGuid)` Get ISARelationship relationship
`LibraryCategoryReference`	`getLibraryCategoryReferenceRelationshipByGuid(String userId, String relationshipGuid)` Get LibraryCategoryReference relationship
`LibraryTermReference`	`getLibraryTermReferenceRelationshipByGuid(String userId, String relationshipGuid)` Get LibraryTermReference relationship
`License`	`getLicenseRelationshipByGuid(String userId, String relationshipGuid)` Get License relationship
`LicenseType`	`getLicenseTypeById(String userId, String entityGuid)` Fetch complete definition of an licenseType given its GUID.
`Set<Line>`	`getLicenseTypeRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity licenseType represented by a guid.
`Like`	`getLikeById(String userId, String entityGuid)` Fetch complete definition of an like given its GUID.
`Set<Line>`	`getLikeRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity like represented by a guid.
`LinkedFile`	`getLinkedFileRelationshipByGuid(String userId, String relationshipGuid)` Get LinkedFile relationship
`LinkedMedia`	`getLinkedMediaRelationshipByGuid(String userId, String relationshipGuid)` Get LinkedMedia relationship
`LinkedType`	`getLinkedTypeRelationshipByGuid(String userId, String relationshipGuid)` Get LinkedType relationship
`Location`	`getLocationById(String userId, String entityGuid)` Fetch complete definition of an location given its GUID.
`Set<Line>`	`getLocationRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity location represented by a guid.
`MapFromElementType`	`getMapFromElementTypeRelationshipByGuid(String userId, String relationshipGuid)` Get MapFromElementType relationship
`MapSchemaType`	`getMapSchemaTypeById(String userId, String entityGuid)` Fetch complete definition of an mapSchemaType given its GUID.
`Set<Line>`	`getMapSchemaTypeRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity mapSchemaType represented by a guid.
`MapToElementType`	`getMapToElementTypeRelationshipByGuid(String userId, String relationshipGuid)` Get MapToElementType relationship
`MediaCollection`	`getMediaCollectionById(String userId, String entityGuid)` Fetch complete definition of an mediaCollection given its GUID.
`Set<Line>`	`getMediaCollectionRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity mediaCollection represented by a guid.
`MediaFile`	`getMediaFileById(String userId, String entityGuid)` Fetch complete definition of an mediaFile given its GUID.
`Set<Line>`	`getMediaFileRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity mediaFile represented by a guid.
`MediaReference`	`getMediaReferenceRelationshipByGuid(String userId, String relationshipGuid)` Get MediaReference relationship
`Meeting`	`getMeetingById(String userId, String entityGuid)` Fetch complete definition of an meeting given its GUID.
`Set<Line>`	`getMeetingRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity meeting represented by a guid.
`MetadataCohortPeer`	`getMetadataCohortPeerRelationshipByGuid(String userId, String relationshipGuid)` Get MetadataCohortPeer relationship
`MetadataCollection`	`getMetadataCollectionById(String userId, String entityGuid)` Fetch complete definition of an metadataCollection given its GUID.
`Set<Line>`	`getMetadataCollectionRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity metadataCollection represented by a guid.
`MetadataRepositoryCohort`	`getMetadataRepositoryCohortById(String userId, String entityGuid)` Fetch complete definition of an metadataRepositoryCohort given its GUID.
`Set<Line>`	`getMetadataRepositoryCohortRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity metadataRepositoryCohort represented by a guid.
`NestedFile`	`getNestedFileRelationshipByGuid(String userId, String relationshipGuid)` Get NestedFile relationship
`NestedLocation`	`getNestedLocationRelationshipByGuid(String userId, String relationshipGuid)` Get NestedLocation relationship
`Network`	`getNetworkById(String userId, String entityGuid)` Fetch complete definition of an network given its GUID.
`NetworkGateway`	`getNetworkGatewayById(String userId, String entityGuid)` Fetch complete definition of an networkGateway given its GUID.
`NetworkGatewayLink`	`getNetworkGatewayLinkRelationshipByGuid(String userId, String relationshipGuid)` Get NetworkGatewayLink relationship
`Set<Line>`	`getNetworkGatewayRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity networkGateway represented by a guid.
`Set<Line>`	`getNetworkRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity network represented by a guid.
`NoteEntry`	`getNoteEntryById(String userId, String entityGuid)` Fetch complete definition of an noteEntry given its GUID.
`Set<Line>`	`getNoteEntryRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity noteEntry represented by a guid.
`NoteLog`	`getNoteLogById(String userId, String entityGuid)` Fetch complete definition of an noteLog given its GUID.
`Set<Line>`	`getNoteLogRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity noteLog represented by a guid.
`OperatingPlatform`	`getOperatingPlatformById(String userId, String entityGuid)` Fetch complete definition of an operatingPlatform given its GUID.
`Set<Line>`	`getOperatingPlatformRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity operatingPlatform represented by a guid.
`OrganizationalCapability`	`getOrganizationalCapabilityRelationshipByGuid(String userId, String relationshipGuid)` Get OrganizationalCapability relationship
`Peer`	`getPeerRelationshipByGuid(String userId, String relationshipGuid)` Get Peer relationship
`Person`	`getPersonById(String userId, String entityGuid)` Fetch complete definition of an person given its GUID.
`Set<Line>`	`getPersonRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity person represented by a guid.
`PreferredTerm`	`getPreferredTermRelationshipByGuid(String userId, String relationshipGuid)` Get PreferredTerm relationship
`Process`	`getProcessById(String userId, String entityGuid)` Fetch complete definition of an process given its GUID.
`ProcessInput`	`getProcessInputRelationshipByGuid(String userId, String relationshipGuid)` Get ProcessInput relationship
`ProcessOutput`	`getProcessOutputRelationshipByGuid(String userId, String relationshipGuid)` Get ProcessOutput relationship
`Set<Line>`	`getProcessRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity process represented by a guid.
`ProfileIdentity`	`getProfileIdentityRelationshipByGuid(String userId, String relationshipGuid)` Get ProfileIdentity relationship
`Project`	`getProjectById(String userId, String entityGuid)` Fetch complete definition of an project given its GUID.
`ProjectCharter`	`getProjectCharterById(String userId, String entityGuid)` Fetch complete definition of an projectCharter given its GUID.
`ProjectCharterLink`	`getProjectCharterLinkRelationshipByGuid(String userId, String relationshipGuid)` Get ProjectCharterLink relationship
`Set<Line>`	`getProjectCharterRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity projectCharter represented by a guid.
`ProjectDependency`	`getProjectDependencyRelationshipByGuid(String userId, String relationshipGuid)` Get ProjectDependency relationship
`ProjectHierarchy`	`getProjectHierarchyRelationshipByGuid(String userId, String relationshipGuid)` Get ProjectHierarchy relationship
`Set<Line>`	`getProjectRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity project represented by a guid.
`ProjectScope`	`getProjectScopeRelationshipByGuid(String userId, String relationshipGuid)` Get ProjectScope relationship
`ProjectTeam`	`getProjectTeamRelationshipByGuid(String userId, String relationshipGuid)` Get ProjectTeam relationship
`PropertyFacet`	`getPropertyFacetById(String userId, String entityGuid)` Fetch complete definition of an propertyFacet given its GUID.
`Set<Line>`	`getPropertyFacetRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity propertyFacet represented by a guid.
`Rating`	`getRatingById(String userId, String entityGuid)` Fetch complete definition of an rating given its GUID.
`Set<Line>`	`getRatingRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity rating represented by a guid.
`Referenceable`	`getReferenceableById(String userId, String entityGuid)` Fetch complete definition of an referenceable given its GUID.
`ReferenceableFacet`	`getReferenceableFacetRelationshipByGuid(String userId, String relationshipGuid)` Get ReferenceableFacet relationship
`Set<Line>`	`getReferenceableRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity referenceable represented by a guid.
`Regulation`	`getRegulationById(String userId, String entityGuid)` Fetch complete definition of an regulation given its GUID.
`RegulationCertificationType`	`getRegulationCertificationTypeRelationshipByGuid(String userId, String relationshipGuid)` Get RegulationCertificationType relationship
`Set<Line>`	`getRegulationRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity regulation represented by a guid.
`RelatedMedia`	`getRelatedMediaById(String userId, String entityGuid)` Fetch complete definition of an relatedMedia given its GUID.
`Set<Line>`	`getRelatedMediaRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity relatedMedia represented by a guid.
`RelatedTerm`	`getRelatedTermRelationshipByGuid(String userId, String relationshipGuid)` Get RelatedTerm relationship
`ReplacementTerm`	`getReplacementTermRelationshipByGuid(String userId, String relationshipGuid)` Get ReplacementTerm relationship
`ResponsibilityStaffContact`	`getResponsibilityStaffContactRelationshipByGuid(String userId, String relationshipGuid)` Get ResponsibilityStaffContact relationship
`RuntimeForProcess`	`getRuntimeForProcessRelationshipByGuid(String userId, String relationshipGuid)` Get RuntimeForProcess relationship
`SchemaAttribute`	`getSchemaAttributeById(String userId, String entityGuid)` Fetch complete definition of an schemaAttribute given its GUID.
`Set<Line>`	`getSchemaAttributeRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity schemaAttribute represented by a guid.
`SchemaAttributeType`	`getSchemaAttributeTypeRelationshipByGuid(String userId, String relationshipGuid)` Get SchemaAttributeType relationship
`SchemaLinkElement`	`getSchemaLinkElementById(String userId, String entityGuid)` Fetch complete definition of an schemaLinkElement given its GUID.
`Set<Line>`	`getSchemaLinkElementRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity schemaLinkElement represented by a guid.
`SchemaLinkToType`	`getSchemaLinkToTypeRelationshipByGuid(String userId, String relationshipGuid)` Get SchemaLinkToType relationship
`SchemaQueryImplementation`	`getSchemaQueryImplementationRelationshipByGuid(String userId, String relationshipGuid)` Get SchemaQueryImplementation relationship
`SchemaType`	`getSchemaTypeById(String userId, String entityGuid)` Fetch complete definition of an schemaType given its GUID.
`SchemaTypeImplementation`	`getSchemaTypeImplementationRelationshipByGuid(String userId, String relationshipGuid)` Get SchemaTypeImplementation relationship
`Set<Line>`	`getSchemaTypeRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity schemaType represented by a guid.
`SemanticAssignment`	`getSemanticAssignmentRelationshipByGuid(String userId, String relationshipGuid)` Get SemanticAssignment relationship
`ServerEndpoint`	`getServerEndpointRelationshipByGuid(String userId, String relationshipGuid)` Get ServerEndpoint relationship
`SoftwareServer`	`getSoftwareServerById(String userId, String entityGuid)` Fetch complete definition of an softwareServer given its GUID.
`SoftwareServerCapability`	`getSoftwareServerCapabilityById(String userId, String entityGuid)` Fetch complete definition of an softwareServerCapability given its GUID.
`Set<Line>`	`getSoftwareServerCapabilityRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity softwareServerCapability represented by a guid.
`SoftwareServerPlatform`	`getSoftwareServerPlatformById(String userId, String entityGuid)` Fetch complete definition of an softwareServerPlatform given its GUID.
`Set<Line>`	`getSoftwareServerPlatformRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity softwareServerPlatform represented by a guid.
`Set<Line>`	`getSoftwareServerRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity softwareServer represented by a guid.
`SubscriberList`	`getSubscriberListById(String userId, String entityGuid)` Fetch complete definition of an subscriberList given its GUID.
`Set<Line>`	`getSubscriberListRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity subscriberList represented by a guid.
`Synonym`	`getSynonymRelationshipByGuid(String userId, String relationshipGuid)` Get Synonym relationship
`Team`	`getTeamById(String userId, String entityGuid)` Fetch complete definition of an team given its GUID.
`Set<Line>`	`getTeamRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity team represented by a guid.
`TermAnchor`	`getTermAnchorRelationshipByGuid(String userId, String relationshipGuid)` Get TermAnchor relationship
`TermCategorization`	`getTermCategorizationRelationshipByGuid(String userId, String relationshipGuid)` Get TermCategorization relationship
`TermHASARelationship`	`getTermHASARelationshipRelationshipByGuid(String userId, String relationshipGuid)` Get TermHASARelationship relationship
`TermISATypeOFRelationship`	`getTermISATypeOFRelationshipRelationshipByGuid(String userId, String relationshipGuid)` Get TermISATypeOFRelationship relationship
`TermTYPEDBYRelationship`	`getTermTYPEDBYRelationshipRelationshipByGuid(String userId, String relationshipGuid)` Get TermTYPEDBYRelationship relationship
`ToDo`	`getToDoById(String userId, String entityGuid)` Fetch complete definition of an toDo given its GUID.
`Set<Line>`	`getToDoRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity toDo represented by a guid.
`ToDoSource`	`getToDoSourceRelationshipByGuid(String userId, String relationshipGuid)` Get ToDoSource relationship
`Topic`	`getTopicById(String userId, String entityGuid)` Fetch complete definition of an topic given its GUID.
`Set<Line>`	`getTopicRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity topic represented by a guid.
`TopicSubscribers`	`getTopicSubscribersRelationshipByGuid(String userId, String relationshipGuid)` Get TopicSubscribers relationship
`Translation`	`getTranslationRelationshipByGuid(String userId, String relationshipGuid)` Get Translation relationship
`UsedInContext`	`getUsedInContextRelationshipByGuid(String userId, String relationshipGuid)` Get UsedInContext relationship
`UserIdentity`	`getUserIdentityById(String userId, String entityGuid)` Fetch complete definition of an userIdentity given its GUID.
`Set<Line>`	`getUserIdentityRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity userIdentity represented by a guid.
`ValidValue`	`getValidValueRelationshipByGuid(String userId, String relationshipGuid)` Get ValidValue relationship
`VirtualConnection`	`getVirtualConnectionById(String userId, String entityGuid)` Fetch complete definition of an virtualConnection given its GUID.
`Set<Line>`	`getVirtualConnectionRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity virtualConnection represented by a guid.
`VirtualContainer`	`getVirtualContainerById(String userId, String entityGuid)` Fetch complete definition of an virtualContainer given its GUID.
`Set<Line>`	`getVirtualContainerRelationships(String userId, String entityGuid, String relationshipTypeGuid, int fromRelationshipElement, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)` Get the relationships associated with entity virtualContainer represented by a guid.
`ZoneGovernance`	`getZoneGovernanceRelationshipByGuid(String userId, String relationshipGuid)` Get ZoneGovernance relationship
`void`	`purgeActorProfileByGuid(String userId, String entityGuid)` Purge an actorProfile identified by its GUID.
`void`	`purgeAPIOperationByGuid(String userId, String entityGuid)` Purge an aPIOperation identified by its GUID.
`void`	`purgeAPISchemaTypeByGuid(String userId, String entityGuid)` Purge an aPISchemaType identified by its GUID.
`void`	`purgeApplicationByGuid(String userId, String entityGuid)` Purge an application identified by its GUID.
`void`	`purgeAssetByGuid(String userId, String entityGuid)` Purge an asset identified by its GUID.
`void`	`purgeBusinessCapabilityByGuid(String userId, String entityGuid)` Purge an businessCapability identified by its GUID.
`void`	`purgeCertificationTypeByGuid(String userId, String entityGuid)` Purge an certificationType identified by its GUID.
`void`	`purgeCohortMemberByGuid(String userId, String entityGuid)` Purge an cohortMember identified by its GUID.
`void`	`purgeCollectionByGuid(String userId, String entityGuid)` Purge an collection identified by its GUID.
`void`	`purgeCommentByGuid(String userId, String entityGuid)` Purge an comment identified by its GUID.
`void`	`purgeCommunityByGuid(String userId, String entityGuid)` Purge an community identified by its GUID.
`void`	`purgeCommunityMemberByGuid(String userId, String entityGuid)` Purge an communityMember identified by its GUID.
`void`	`purgeComplexSchemaTypeByGuid(String userId, String entityGuid)` Purge an complexSchemaType identified by its GUID.
`void`	`purgeConnectionByGuid(String userId, String entityGuid)` Purge an connection identified by its GUID.
`void`	`purgeConnectorTypeByGuid(String userId, String entityGuid)` Purge an connectorType identified by its GUID.
`void`	`purgeContactDetailsByGuid(String userId, String entityGuid)` Purge an contactDetails identified by its GUID.
`void`	`purgeDataFileByGuid(String userId, String entityGuid)` Purge an dataFile identified by its GUID.
`void`	`purgeDataSetByGuid(String userId, String entityGuid)` Purge an dataSet identified by its GUID.
`void`	`purgeDeployedAPIByGuid(String userId, String entityGuid)` Purge an deployedAPI identified by its GUID.
`void`	`purgeDeployedSoftwareComponentByGuid(String userId, String entityGuid)` Purge an deployedSoftwareComponent identified by its GUID.
`void`	`purgeDerivedSchemaAttributeByGuid(String userId, String entityGuid)` Purge an derivedSchemaAttribute identified by its GUID.
`void`	`purgeEndpointByGuid(String userId, String entityGuid)` Purge an endpoint identified by its GUID.
`void`	`purgeExternalGlossaryLinkByGuid(String userId, String entityGuid)` Purge an externalGlossaryLink identified by its GUID.
`void`	`purgeExternalIdByGuid(String userId, String entityGuid)` Purge an externalId identified by its GUID.
`void`	`purgeExternalReferenceByGuid(String userId, String entityGuid)` Purge an externalReference identified by its GUID.
`void`	`purgeFileFolderByGuid(String userId, String entityGuid)` Purge an fileFolder identified by its GUID.
`void`	`purgeGlossaryByGuid(String userId, String entityGuid)` Purge an glossary identified by its GUID.
`void`	`purgeGlossaryCategoryByGuid(String userId, String entityGuid)` Purge an glossaryCategory identified by its GUID.
`void`	`purgeGlossaryTermByGuid(String userId, String entityGuid)` Purge an glossaryTerm identified by its GUID.
`void`	`purgeGovernanceControlByGuid(String userId, String entityGuid)` Purge an governanceControl identified by its GUID.
`void`	`purgeGovernanceDefinitionByGuid(String userId, String entityGuid)` Purge an governanceDefinition identified by its GUID.
`void`	`purgeGovernanceDriverByGuid(String userId, String entityGuid)` Purge an governanceDriver identified by its GUID.
`void`	`purgeGovernanceMetricByGuid(String userId, String entityGuid)` Purge an governanceMetric identified by its GUID.
`void`	`purgeGovernancePolicyByGuid(String userId, String entityGuid)` Purge an governancePolicy identified by its GUID.
`void`	`purgeGovernanceProcessByGuid(String userId, String entityGuid)` Purge an governanceProcess identified by its GUID.
`void`	`purgeGovernanceResponsibilityByGuid(String userId, String entityGuid)` Purge an governanceResponsibility identified by its GUID.
`void`	`purgeGovernanceRuleByGuid(String userId, String entityGuid)` Purge an governanceRule identified by its GUID.
`void`	`purgeGovernanceZoneByGuid(String userId, String entityGuid)` Purge an governanceZone identified by its GUID.
`void`	`purgeGraphEdgeByGuid(String userId, String entityGuid)` Purge an graphEdge identified by its GUID.
`void`	`purgeGraphVertexByGuid(String userId, String entityGuid)` Purge an graphVertex identified by its GUID.
`void`	`purgeHostByGuid(String userId, String entityGuid)` Purge an host identified by its GUID.
`void`	`purgeHostClusterByGuid(String userId, String entityGuid)` Purge an hostCluster identified by its GUID.
`void`	`purgeImplementationSnippetByGuid(String userId, String entityGuid)` Purge an implementationSnippet identified by its GUID.
`void`	`purgeInformalTagByGuid(String userId, String entityGuid)` Purge an informalTag identified by its GUID.
`void`	`purgeLicenseTypeByGuid(String userId, String entityGuid)` Purge an licenseType identified by its GUID.
`void`	`purgeLikeByGuid(String userId, String entityGuid)` Purge an like identified by its GUID.
`void`	`purgeLocationByGuid(String userId, String entityGuid)` Purge an location identified by its GUID.
`void`	`purgeMapSchemaTypeByGuid(String userId, String entityGuid)` Purge an mapSchemaType identified by its GUID.
`void`	`purgeMediaCollectionByGuid(String userId, String entityGuid)` Purge an mediaCollection identified by its GUID.
`void`	`purgeMediaFileByGuid(String userId, String entityGuid)` Purge an mediaFile identified by its GUID.
`void`	`purgeMeetingByGuid(String userId, String entityGuid)` Purge an meeting identified by its GUID.
`void`	`purgeMetadataCollectionByGuid(String userId, String entityGuid)` Purge an metadataCollection identified by its GUID.
`void`	`purgeMetadataRepositoryCohortByGuid(String userId, String entityGuid)` Purge an metadataRepositoryCohort identified by its GUID.
`void`	`purgeNetworkByGuid(String userId, String entityGuid)` Purge an network identified by its GUID.
`void`	`purgeNetworkGatewayByGuid(String userId, String entityGuid)` Purge an networkGateway identified by its GUID.
`void`	`purgeNoteEntryByGuid(String userId, String entityGuid)` Purge an noteEntry identified by its GUID.
`void`	`purgeNoteLogByGuid(String userId, String entityGuid)` Purge an noteLog identified by its GUID.
`void`	`purgeOperatingPlatformByGuid(String userId, String entityGuid)` Purge an operatingPlatform identified by its GUID.
`void`	`purgePersonByGuid(String userId, String entityGuid)` Purge an person identified by its GUID.
`void`	`purgeProcessByGuid(String userId, String entityGuid)` Purge an process identified by its GUID.
`void`	`purgeProjectByGuid(String userId, String entityGuid)` Purge an project identified by its GUID.
`void`	`purgeProjectCharterByGuid(String userId, String entityGuid)` Purge an projectCharter identified by its GUID.
`void`	`purgePropertyFacetByGuid(String userId, String entityGuid)` Purge an propertyFacet identified by its GUID.
`void`	`purgeRatingByGuid(String userId, String entityGuid)` Purge an rating identified by its GUID.
`void`	`purgeReferenceableByGuid(String userId, String entityGuid)` Purge an referenceable identified by its GUID.
`void`	`purgeRegulationByGuid(String userId, String entityGuid)` Purge an regulation identified by its GUID.
`void`	`purgeRelatedMediaByGuid(String userId, String entityGuid)` Purge an relatedMedia identified by its GUID.
`void`	`purgeRelationshipById(String userId, String relationshipGuid, String typeName)` Purge relationship
`void`	`purgeSchemaAttributeByGuid(String userId, String entityGuid)` Purge an schemaAttribute identified by its GUID.
`void`	`purgeSchemaLinkElementByGuid(String userId, String entityGuid)` Purge an schemaLinkElement identified by its GUID.
`void`	`purgeSchemaTypeByGuid(String userId, String entityGuid)` Purge an schemaType identified by its GUID.
`void`	`purgeSoftwareServerByGuid(String userId, String entityGuid)` Purge an softwareServer identified by its GUID.
`void`	`purgeSoftwareServerCapabilityByGuid(String userId, String entityGuid)` Purge an softwareServerCapability identified by its GUID.
`void`	`purgeSoftwareServerPlatformByGuid(String userId, String entityGuid)` Purge an softwareServerPlatform identified by its GUID.
`void`	`purgeSubscriberListByGuid(String userId, String entityGuid)` Purge an subscriberList identified by its GUID.
`void`	`purgeTeamByGuid(String userId, String entityGuid)` Purge an team identified by its GUID.
`void`	`purgeToDoByGuid(String userId, String entityGuid)` Purge an toDo identified by its GUID.
`void`	`purgeTopicByGuid(String userId, String entityGuid)` Purge an topic identified by its GUID.
`void`	`purgeUserIdentityByGuid(String userId, String entityGuid)` Purge an userIdentity identified by its GUID.
`void`	`purgeVirtualConnectionByGuid(String userId, String entityGuid)` Purge an virtualConnection identified by its GUID.
`void`	`purgeVirtualContainerByGuid(String userId, String entityGuid)` Purge an virtualContainer identified by its GUID.
`ActorProfile`	`restoreActorProfile(String userId, String entityGuid)` Restore an ActorProfile identified by its GUID.
`APIOperation`	`restoreAPIOperation(String userId, String entityGuid)` Restore an APIOperation identified by its GUID.
`APISchemaType`	`restoreAPISchemaType(String userId, String entityGuid)` Restore an APISchemaType identified by its GUID.
`Application`	`restoreApplication(String userId, String entityGuid)` Restore an Application identified by its GUID.
`Asset`	`restoreAsset(String userId, String entityGuid)` Restore an Asset identified by its GUID.
`BusinessCapability`	`restoreBusinessCapability(String userId, String entityGuid)` Restore an BusinessCapability identified by its GUID.
`CertificationType`	`restoreCertificationType(String userId, String entityGuid)` Restore an CertificationType identified by its GUID.
`CohortMember`	`restoreCohortMember(String userId, String entityGuid)` Restore an CohortMember identified by its GUID.
`Collection`	`restoreCollection(String userId, String entityGuid)` Restore an Collection identified by its GUID.
`Comment`	`restoreComment(String userId, String entityGuid)` Restore an Comment identified by its GUID.
`Community`	`restoreCommunity(String userId, String entityGuid)` Restore an Community identified by its GUID.
`CommunityMember`	`restoreCommunityMember(String userId, String entityGuid)` Restore an CommunityMember identified by its GUID.
`ComplexSchemaType`	`restoreComplexSchemaType(String userId, String entityGuid)` Restore an ComplexSchemaType identified by its GUID.
`Connection`	`restoreConnection(String userId, String entityGuid)` Restore an Connection identified by its GUID.
`ConnectorType`	`restoreConnectorType(String userId, String entityGuid)` Restore an ConnectorType identified by its GUID.
`ContactDetails`	`restoreContactDetails(String userId, String entityGuid)` Restore an ContactDetails identified by its GUID.
`DataFile`	`restoreDataFile(String userId, String entityGuid)` Restore an DataFile identified by its GUID.
`DataSet`	`restoreDataSet(String userId, String entityGuid)` Restore an DataSet identified by its GUID.
`DeployedAPI`	`restoreDeployedAPI(String userId, String entityGuid)` Restore an DeployedAPI identified by its GUID.
`DeployedSoftwareComponent`	`restoreDeployedSoftwareComponent(String userId, String entityGuid)` Restore an DeployedSoftwareComponent identified by its GUID.
`DerivedSchemaAttribute`	`restoreDerivedSchemaAttribute(String userId, String entityGuid)` Restore an DerivedSchemaAttribute identified by its GUID.
`Endpoint`	`restoreEndpoint(String userId, String entityGuid)` Restore an Endpoint identified by its GUID.
`ExternalGlossaryLink`	`restoreExternalGlossaryLink(String userId, String entityGuid)` Restore an ExternalGlossaryLink identified by its GUID.
`ExternalId`	`restoreExternalId(String userId, String entityGuid)` Restore an ExternalId identified by its GUID.
`ExternalReference`	`restoreExternalReference(String userId, String entityGuid)` Restore an ExternalReference identified by its GUID.
`FileFolder`	`restoreFileFolder(String userId, String entityGuid)` Restore an FileFolder identified by its GUID.
`Glossary`	`restoreGlossary(String userId, String entityGuid)` Restore an Glossary identified by its GUID.
`GlossaryCategory`	`restoreGlossaryCategory(String userId, String entityGuid)` Restore an GlossaryCategory identified by its GUID.
`GlossaryTerm`	`restoreGlossaryTerm(String userId, String entityGuid)` Restore an GlossaryTerm identified by its GUID.
`GovernanceControl`	`restoreGovernanceControl(String userId, String entityGuid)` Restore an GovernanceControl identified by its GUID.
`GovernanceDefinition`	`restoreGovernanceDefinition(String userId, String entityGuid)` Restore an GovernanceDefinition identified by its GUID.
`GovernanceDriver`	`restoreGovernanceDriver(String userId, String entityGuid)` Restore an GovernanceDriver identified by its GUID.
`GovernanceMetric`	`restoreGovernanceMetric(String userId, String entityGuid)` Restore an GovernanceMetric identified by its GUID.
`GovernancePolicy`	`restoreGovernancePolicy(String userId, String entityGuid)` Restore an GovernancePolicy identified by its GUID.
`GovernanceProcess`	`restoreGovernanceProcess(String userId, String entityGuid)` Restore an GovernanceProcess identified by its GUID.
`GovernanceResponsibility`	`restoreGovernanceResponsibility(String userId, String entityGuid)` Restore an GovernanceResponsibility identified by its GUID.
`GovernanceRule`	`restoreGovernanceRule(String userId, String entityGuid)` Restore an GovernanceRule identified by its GUID.
`GovernanceZone`	`restoreGovernanceZone(String userId, String entityGuid)` Restore an GovernanceZone identified by its GUID.
`GraphEdge`	`restoreGraphEdge(String userId, String entityGuid)` Restore an GraphEdge identified by its GUID.
`GraphVertex`	`restoreGraphVertex(String userId, String entityGuid)` Restore an GraphVertex identified by its GUID.
`Host`	`restoreHost(String userId, String entityGuid)` Restore an Host identified by its GUID.
`HostCluster`	`restoreHostCluster(String userId, String entityGuid)` Restore an HostCluster identified by its GUID.
`ImplementationSnippet`	`restoreImplementationSnippet(String userId, String entityGuid)` Restore an ImplementationSnippet identified by its GUID.
`InformalTag`	`restoreInformalTag(String userId, String entityGuid)` Restore an InformalTag identified by its GUID.
`LicenseType`	`restoreLicenseType(String userId, String entityGuid)` Restore an LicenseType identified by its GUID.
`Like`	`restoreLike(String userId, String entityGuid)` Restore an Like identified by its GUID.
`Location`	`restoreLocation(String userId, String entityGuid)` Restore an Location identified by its GUID.
`MapSchemaType`	`restoreMapSchemaType(String userId, String entityGuid)` Restore an MapSchemaType identified by its GUID.
`MediaCollection`	`restoreMediaCollection(String userId, String entityGuid)` Restore an MediaCollection identified by its GUID.
`MediaFile`	`restoreMediaFile(String userId, String entityGuid)` Restore an MediaFile identified by its GUID.
`Meeting`	`restoreMeeting(String userId, String entityGuid)` Restore an Meeting identified by its GUID.
`MetadataCollection`	`restoreMetadataCollection(String userId, String entityGuid)` Restore an MetadataCollection identified by its GUID.
`MetadataRepositoryCohort`	`restoreMetadataRepositoryCohort(String userId, String entityGuid)` Restore an MetadataRepositoryCohort identified by its GUID.
`Network`	`restoreNetwork(String userId, String entityGuid)` Restore an Network identified by its GUID.
`NetworkGateway`	`restoreNetworkGateway(String userId, String entityGuid)` Restore an NetworkGateway identified by its GUID.
`NoteEntry`	`restoreNoteEntry(String userId, String entityGuid)` Restore an NoteEntry identified by its GUID.
`NoteLog`	`restoreNoteLog(String userId, String entityGuid)` Restore an NoteLog identified by its GUID.
`OperatingPlatform`	`restoreOperatingPlatform(String userId, String entityGuid)` Restore an OperatingPlatform identified by its GUID.
`Person`	`restorePerson(String userId, String entityGuid)` Restore an Person identified by its GUID.
`Process`	`restoreProcess(String userId, String entityGuid)` Restore an Process identified by its GUID.
`Project`	`restoreProject(String userId, String entityGuid)` Restore an Project identified by its GUID.
`ProjectCharter`	`restoreProjectCharter(String userId, String entityGuid)` Restore an ProjectCharter identified by its GUID.
`PropertyFacet`	`restorePropertyFacet(String userId, String entityGuid)` Restore an PropertyFacet identified by its GUID.
`Rating`	`restoreRating(String userId, String entityGuid)` Restore an Rating identified by its GUID.
`Referenceable`	`restoreReferenceable(String userId, String entityGuid)` Restore an Referenceable identified by its GUID.
`Regulation`	`restoreRegulation(String userId, String entityGuid)` Restore an Regulation identified by its GUID.
`RelatedMedia`	`restoreRelatedMedia(String userId, String entityGuid)` Restore an RelatedMedia identified by its GUID.
`Relationship`	`restoreRelationship(String userId, String relationshipGuid)` Restore an relationship identified by its GUID.
`SchemaAttribute`	`restoreSchemaAttribute(String userId, String entityGuid)` Restore an SchemaAttribute identified by its GUID.
`SchemaLinkElement`	`restoreSchemaLinkElement(String userId, String entityGuid)` Restore an SchemaLinkElement identified by its GUID.
`SchemaType`	`restoreSchemaType(String userId, String entityGuid)` Restore an SchemaType identified by its GUID.
`SoftwareServer`	`restoreSoftwareServer(String userId, String entityGuid)` Restore an SoftwareServer identified by its GUID.
`SoftwareServerCapability`	`restoreSoftwareServerCapability(String userId, String entityGuid)` Restore an SoftwareServerCapability identified by its GUID.
`SoftwareServerPlatform`	`restoreSoftwareServerPlatform(String userId, String entityGuid)` Restore an SoftwareServerPlatform identified by its GUID.
`SubscriberList`	`restoreSubscriberList(String userId, String entityGuid)` Restore an SubscriberList identified by its GUID.
`Team`	`restoreTeam(String userId, String entityGuid)` Restore an Team identified by its GUID.
`ToDo`	`restoreToDo(String userId, String entityGuid)` Restore an ToDo identified by its GUID.
`Topic`	`restoreTopic(String userId, String entityGuid)` Restore an Topic identified by its GUID.
`UserIdentity`	`restoreUserIdentity(String userId, String entityGuid)` Restore an UserIdentity identified by its GUID.
`VirtualConnection`	`restoreVirtualConnection(String userId, String entityGuid)` Restore an VirtualConnection identified by its GUID.
`VirtualContainer`	`restoreVirtualContainer(String userId, String entityGuid)` Restore an VirtualContainer identified by its GUID.
`void`	`setOMRSAPIHelper(OMRSAPIHelper oMRSAPIHelper)`
`AcceptedAnswer`	`updateAcceptedAnswerRelationship(String userId, AcceptedAnswer acceptedAnswer)` Update AcceptedAnswer relationship
`ActorProfile`	`updateActorProfile(String userId, ActorProfile actorProfile)` Update actorProfile
`ActorProfile`	`updateActorProfileClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing actorProfile represented by a guid.
`AdjacentLocation`	`updateAdjacentLocationRelationship(String userId, AdjacentLocation adjacentLocation)` Update AdjacentLocation relationship
`Antonym`	`updateAntonymRelationship(String userId, Antonym antonym)` Update Antonym relationship
`APIEndpoint`	`updateAPIEndpointRelationship(String userId, APIEndpoint aPIEndpoint)` Update APIEndpoint relationship
`APIHeader`	`updateAPIHeaderRelationship(String userId, APIHeader aPIHeader)` Update APIHeader relationship
`APIOperation`	`updateAPIOperation(String userId, APIOperation aPIOperation)` Update aPIOperation
`APIOperation`	`updateAPIOperationClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing aPIOperation represented by a guid.
`APIOperations`	`updateAPIOperationsRelationship(String userId, APIOperations aPIOperations)` Update APIOperations relationship
`APIRequest`	`updateAPIRequestRelationship(String userId, APIRequest aPIRequest)` Update APIRequest relationship
`APIResponse`	`updateAPIResponseRelationship(String userId, APIResponse aPIResponse)` Update APIResponse relationship
`APISchemaType`	`updateAPISchemaType(String userId, APISchemaType aPISchemaType)` Update aPISchemaType
`APISchemaType`	`updateAPISchemaTypeClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing aPISchemaType represented by a guid.
`Application`	`updateApplication(String userId, Application application)` Update application
`Application`	`updateApplicationClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing application represented by a guid.
`Asset`	`updateAsset(String userId, Asset asset)` Update asset
`Asset`	`updateAssetClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing asset represented by a guid.
`AssetLocation`	`updateAssetLocationRelationship(String userId, AssetLocation assetLocation)` Update AssetLocation relationship
`AssetSchemaType`	`updateAssetSchemaTypeRelationship(String userId, AssetSchemaType assetSchemaType)` Update AssetSchemaType relationship
`AssetServerUse`	`updateAssetServerUseRelationship(String userId, AssetServerUse assetServerUse)` Update AssetServerUse relationship
`AttachedComment`	`updateAttachedCommentRelationship(String userId, AttachedComment attachedComment)` Update AttachedComment relationship
`AttachedLike`	`updateAttachedLikeRelationship(String userId, AttachedLike attachedLike)` Update AttachedLike relationship
`AttachedNoteLogEntry`	`updateAttachedNoteLogEntryRelationship(String userId, AttachedNoteLogEntry attachedNoteLogEntry)` Update AttachedNoteLogEntry relationship
`AttachedNoteLog`	`updateAttachedNoteLogRelationship(String userId, AttachedNoteLog attachedNoteLog)` Update AttachedNoteLog relationship
`AttachedRating`	`updateAttachedRatingRelationship(String userId, AttachedRating attachedRating)` Update AttachedRating relationship
`AttachedTag`	`updateAttachedTagRelationship(String userId, AttachedTag attachedTag)` Update AttachedTag relationship
`AttributeForSchema`	`updateAttributeForSchemaRelationship(String userId, AttributeForSchema attributeForSchema)` Update AttributeForSchema relationship
`BusinessCapability`	`updateBusinessCapability(String userId, BusinessCapability businessCapability)` Update businessCapability
`BusinessCapability`	`updateBusinessCapabilityClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing businessCapability represented by a guid.
`CategoryAnchor`	`updateCategoryAnchorRelationship(String userId, CategoryAnchor categoryAnchor)` Update CategoryAnchor relationship
`CategoryHierarchyLink`	`updateCategoryHierarchyLinkRelationship(String userId, CategoryHierarchyLink categoryHierarchyLink)` Update CategoryHierarchyLink relationship
`Certification`	`updateCertificationRelationship(String userId, Certification certification)` Update Certification relationship
`CertificationType`	`updateCertificationType(String userId, CertificationType certificationType)` Update certificationType
`CertificationType`	`updateCertificationTypeClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing certificationType represented by a guid.
`CohortMember`	`updateCohortMember(String userId, CohortMember cohortMember)` Update cohortMember
`CohortMember`	`updateCohortMemberClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing cohortMember represented by a guid.
`CohortMemberMetadataCollection`	`updateCohortMemberMetadataCollectionRelationship(String userId, CohortMemberMetadataCollection cohortMemberMetadataCollection)` Update CohortMemberMetadataCollection relationship
`Collection`	`updateCollection(String userId, Collection collection)` Update collection
`Collection`	`updateCollectionClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing collection represented by a guid.
`Comment`	`updateComment(String userId, Comment comment)` Update comment
`Comment`	`updateCommentClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing comment represented by a guid.
`Community`	`updateCommunity(String userId, Community community)` Update community
`Community`	`updateCommunityClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing community represented by a guid.
`CommunityMember`	`updateCommunityMember(String userId, CommunityMember communityMember)` Update communityMember
`CommunityMember`	`updateCommunityMemberClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing communityMember represented by a guid.
`CommunityMembership`	`updateCommunityMembershipRelationship(String userId, CommunityMembership communityMembership)` Update CommunityMembership relationship
`ComplexSchemaType`	`updateComplexSchemaType(String userId, ComplexSchemaType complexSchemaType)` Update complexSchemaType
`ComplexSchemaType`	`updateComplexSchemaTypeClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing complexSchemaType represented by a guid.
`Connection`	`updateConnection(String userId, Connection connection)` Update connection
`Connection`	`updateConnectionClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing connection represented by a guid.
`ConnectionConnectorType`	`updateConnectionConnectorTypeRelationship(String userId, ConnectionConnectorType connectionConnectorType)` Update ConnectionConnectorType relationship
`ConnectionEndpoint`	`updateConnectionEndpointRelationship(String userId, ConnectionEndpoint connectionEndpoint)` Update ConnectionEndpoint relationship
`ConnectionToAsset`	`updateConnectionToAssetRelationship(String userId, ConnectionToAsset connectionToAsset)` Update ConnectionToAsset relationship
`ConnectorType`	`updateConnectorType(String userId, ConnectorType connectorType)` Update connectorType
`ConnectorType`	`updateConnectorTypeClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing connectorType represented by a guid.
`ContactDetails`	`updateContactDetails(String userId, ContactDetails contactDetails)` Update contactDetails
`ContactDetails`	`updateContactDetailsClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing contactDetails represented by a guid.
`ContactThrough`	`updateContactThroughRelationship(String userId, ContactThrough contactThrough)` Update ContactThrough relationship
`DataContentForDataSet`	`updateDataContentForDataSetRelationship(String userId, DataContentForDataSet dataContentForDataSet)` Update DataContentForDataSet relationship
`DataFile`	`updateDataFile(String userId, DataFile dataFile)` Update dataFile
`DataFile`	`updateDataFileClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing dataFile represented by a guid.
`DataSet`	`updateDataSet(String userId, DataSet dataSet)` Update dataSet
`DataSet`	`updateDataSetClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing dataSet represented by a guid.
`DeployedAPI`	`updateDeployedAPI(String userId, DeployedAPI deployedAPI)` Update deployedAPI
`DeployedAPI`	`updateDeployedAPIClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing deployedAPI represented by a guid.
`DeployedSoftwareComponent`	`updateDeployedSoftwareComponent(String userId, DeployedSoftwareComponent deployedSoftwareComponent)` Update deployedSoftwareComponent
`DeployedSoftwareComponent`	`updateDeployedSoftwareComponentClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing deployedSoftwareComponent represented by a guid.
`DeployedVirtualContainer`	`updateDeployedVirtualContainerRelationship(String userId, DeployedVirtualContainer deployedVirtualContainer)` Update DeployedVirtualContainer relationship
`DerivedSchemaAttribute`	`updateDerivedSchemaAttribute(String userId, DerivedSchemaAttribute derivedSchemaAttribute)` Update derivedSchemaAttribute
`DerivedSchemaAttribute`	`updateDerivedSchemaAttributeClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing derivedSchemaAttribute represented by a guid.
`EmbeddedConnection`	`updateEmbeddedConnectionRelationship(String userId, EmbeddedConnection embeddedConnection)` Update EmbeddedConnection relationship
`Endpoint`	`updateEndpoint(String userId, Endpoint endpoint)` Update endpoint
`Endpoint`	`updateEndpointClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing endpoint represented by a guid.
`ExternalGlossaryLink`	`updateExternalGlossaryLink(String userId, ExternalGlossaryLink externalGlossaryLink)` Update externalGlossaryLink
`ExternalGlossaryLink`	`updateExternalGlossaryLinkClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing externalGlossaryLink represented by a guid.
`ExternalId`	`updateExternalId(String userId, ExternalId externalId)` Update externalId
`ExternalId`	`updateExternalIdClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing externalId represented by a guid.
`ExternalIdLink`	`updateExternalIdLinkRelationship(String userId, ExternalIdLink externalIdLink)` Update ExternalIdLink relationship
`ExternalIdScope`	`updateExternalIdScopeRelationship(String userId, ExternalIdScope externalIdScope)` Update ExternalIdScope relationship
`ExternallySourcedGlossary`	`updateExternallySourcedGlossaryRelationship(String userId, ExternallySourcedGlossary externallySourcedGlossary)` Update ExternallySourcedGlossary relationship
`ExternalReference`	`updateExternalReference(String userId, ExternalReference externalReference)` Update externalReference
`ExternalReference`	`updateExternalReferenceClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing externalReference represented by a guid.
`ExternalReferenceLink`	`updateExternalReferenceLinkRelationship(String userId, ExternalReferenceLink externalReferenceLink)` Update ExternalReferenceLink relationship
`FileFolder`	`updateFileFolder(String userId, FileFolder fileFolder)` Update fileFolder
`FileFolder`	`updateFileFolderClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing fileFolder represented by a guid.
`FolderHierarchy`	`updateFolderHierarchyRelationship(String userId, FolderHierarchy folderHierarchy)` Update FolderHierarchy relationship
`Glossary`	`updateGlossary(String userId, Glossary glossary)` Update glossary
`GlossaryCategory`	`updateGlossaryCategory(String userId, GlossaryCategory glossaryCategory)` Update glossaryCategory
`GlossaryCategory`	`updateGlossaryCategoryClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing glossaryCategory represented by a guid.
`Glossary`	`updateGlossaryClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing glossary represented by a guid.
`GlossaryTerm`	`updateGlossaryTerm(String userId, GlossaryTerm glossaryTerm)` Update glossaryTerm
`GlossaryTerm`	`updateGlossaryTermClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing glossaryTerm represented by a guid.
`GovernanceControl`	`updateGovernanceControl(String userId, GovernanceControl governanceControl)` Update governanceControl
`GovernanceControl`	`updateGovernanceControlClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing governanceControl represented by a guid.
`GovernanceControlLink`	`updateGovernanceControlLinkRelationship(String userId, GovernanceControlLink governanceControlLink)` Update GovernanceControlLink relationship
`GovernanceDefinition`	`updateGovernanceDefinition(String userId, GovernanceDefinition governanceDefinition)` Update governanceDefinition
`GovernanceDefinition`	`updateGovernanceDefinitionClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing governanceDefinition represented by a guid.
`GovernanceDefinitionMetric`	`updateGovernanceDefinitionMetricRelationship(String userId, GovernanceDefinitionMetric governanceDefinitionMetric)` Update GovernanceDefinitionMetric relationship
`GovernanceDriver`	`updateGovernanceDriver(String userId, GovernanceDriver governanceDriver)` Update governanceDriver
`GovernanceDriver`	`updateGovernanceDriverClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing governanceDriver represented by a guid.
`GovernanceImplementation`	`updateGovernanceImplementationRelationship(String userId, GovernanceImplementation governanceImplementation)` Update GovernanceImplementation relationship
`GovernanceMetric`	`updateGovernanceMetric(String userId, GovernanceMetric governanceMetric)` Update governanceMetric
`GovernanceMetric`	`updateGovernanceMetricClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing governanceMetric represented by a guid.
`GovernancePolicy`	`updateGovernancePolicy(String userId, GovernancePolicy governancePolicy)` Update governancePolicy
`GovernancePolicy`	`updateGovernancePolicyClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing governancePolicy represented by a guid.
`GovernancePolicyLink`	`updateGovernancePolicyLinkRelationship(String userId, GovernancePolicyLink governancePolicyLink)` Update GovernancePolicyLink relationship
`GovernanceProcess`	`updateGovernanceProcess(String userId, GovernanceProcess governanceProcess)` Update governanceProcess
`GovernanceProcess`	`updateGovernanceProcessClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing governanceProcess represented by a guid.
`GovernanceProcessImplementation`	`updateGovernanceProcessImplementationRelationship(String userId, GovernanceProcessImplementation governanceProcessImplementation)` Update GovernanceProcessImplementation relationship
`GovernanceResponse`	`updateGovernanceResponseRelationship(String userId, GovernanceResponse governanceResponse)` Update GovernanceResponse relationship
`GovernanceResponsibility`	`updateGovernanceResponsibility(String userId, GovernanceResponsibility governanceResponsibility)` Update governanceResponsibility
`GovernanceResponsibility`	`updateGovernanceResponsibilityClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing governanceResponsibility represented by a guid.
`GovernanceResults`	`updateGovernanceResultsRelationship(String userId, GovernanceResults governanceResults)` Update GovernanceResults relationship
`GovernanceRule`	`updateGovernanceRule(String userId, GovernanceRule governanceRule)` Update governanceRule
`GovernanceRule`	`updateGovernanceRuleClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing governanceRule represented by a guid.
`GovernanceRuleImplementation`	`updateGovernanceRuleImplementationRelationship(String userId, GovernanceRuleImplementation governanceRuleImplementation)` Update GovernanceRuleImplementation relationship
`GovernanceZone`	`updateGovernanceZone(String userId, GovernanceZone governanceZone)` Update governanceZone
`GovernanceZone`	`updateGovernanceZoneClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing governanceZone represented by a guid.
`GraphEdge`	`updateGraphEdge(String userId, GraphEdge graphEdge)` Update graphEdge
`GraphEdge`	`updateGraphEdgeClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing graphEdge represented by a guid.
`GraphEdgeLink`	`updateGraphEdgeLinkRelationship(String userId, GraphEdgeLink graphEdgeLink)` Update GraphEdgeLink relationship
`GraphVertex`	`updateGraphVertex(String userId, GraphVertex graphVertex)` Update graphVertex
`GraphVertex`	`updateGraphVertexClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing graphVertex represented by a guid.
`GroupedMedia`	`updateGroupedMediaRelationship(String userId, GroupedMedia groupedMedia)` Update GroupedMedia relationship
`Host`	`updateHost(String userId, Host host)` Update host
`Host`	`updateHostClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing host represented by a guid.
`HostCluster`	`updateHostCluster(String userId, HostCluster hostCluster)` Update hostCluster
`HostCluster`	`updateHostClusterClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing hostCluster represented by a guid.
`HostClusterMember`	`updateHostClusterMemberRelationship(String userId, HostClusterMember hostClusterMember)` Update HostClusterMember relationship
`HostLocation`	`updateHostLocationRelationship(String userId, HostLocation hostLocation)` Update HostLocation relationship
`HostNetwork`	`updateHostNetworkRelationship(String userId, HostNetwork hostNetwork)` Update HostNetwork relationship
`HostOperatingPlatform`	`updateHostOperatingPlatformRelationship(String userId, HostOperatingPlatform hostOperatingPlatform)` Update HostOperatingPlatform relationship
`ImplementationSnippet`	`updateImplementationSnippet(String userId, ImplementationSnippet implementationSnippet)` Update implementationSnippet
`ImplementationSnippet`	`updateImplementationSnippetClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing implementationSnippet represented by a guid.
`InformalTag`	`updateInformalTag(String userId, InformalTag informalTag)` Update informalTag
`InformalTag`	`updateInformalTagClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing informalTag represented by a guid.
`ISARelationship`	`updateISARelationshipRelationship(String userId, ISARelationship iSARelationship)` Update ISARelationship relationship
`LibraryCategoryReference`	`updateLibraryCategoryReferenceRelationship(String userId, LibraryCategoryReference libraryCategoryReference)` Update LibraryCategoryReference relationship
`LibraryTermReference`	`updateLibraryTermReferenceRelationship(String userId, LibraryTermReference libraryTermReference)` Update LibraryTermReference relationship
`License`	`updateLicenseRelationship(String userId, License license)` Update License relationship
`LicenseType`	`updateLicenseType(String userId, LicenseType licenseType)` Update licenseType
`LicenseType`	`updateLicenseTypeClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing licenseType represented by a guid.
`Like`	`updateLike(String userId, Like like)` Update like
`Like`	`updateLikeClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing like represented by a guid.
`LinkedFile`	`updateLinkedFileRelationship(String userId, LinkedFile linkedFile)` Update LinkedFile relationship
`LinkedMedia`	`updateLinkedMediaRelationship(String userId, LinkedMedia linkedMedia)` Update LinkedMedia relationship
`LinkedType`	`updateLinkedTypeRelationship(String userId, LinkedType linkedType)` Update LinkedType relationship
`Location`	`updateLocation(String userId, Location location)` Update location
`Location`	`updateLocationClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing location represented by a guid.
`MapFromElementType`	`updateMapFromElementTypeRelationship(String userId, MapFromElementType mapFromElementType)` Update MapFromElementType relationship
`MapSchemaType`	`updateMapSchemaType(String userId, MapSchemaType mapSchemaType)` Update mapSchemaType
`MapSchemaType`	`updateMapSchemaTypeClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing mapSchemaType represented by a guid.
`MapToElementType`	`updateMapToElementTypeRelationship(String userId, MapToElementType mapToElementType)` Update MapToElementType relationship
`MediaCollection`	`updateMediaCollection(String userId, MediaCollection mediaCollection)` Update mediaCollection
`MediaCollection`	`updateMediaCollectionClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing mediaCollection represented by a guid.
`MediaFile`	`updateMediaFile(String userId, MediaFile mediaFile)` Update mediaFile
`MediaFile`	`updateMediaFileClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing mediaFile represented by a guid.
`MediaReference`	`updateMediaReferenceRelationship(String userId, MediaReference mediaReference)` Update MediaReference relationship
`Meeting`	`updateMeeting(String userId, Meeting meeting)` Update meeting
`Meeting`	`updateMeetingClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing meeting represented by a guid.
`MetadataCohortPeer`	`updateMetadataCohortPeerRelationship(String userId, MetadataCohortPeer metadataCohortPeer)` Update MetadataCohortPeer relationship
`MetadataCollection`	`updateMetadataCollection(String userId, MetadataCollection metadataCollection)` Update metadataCollection
`MetadataCollection`	`updateMetadataCollectionClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing metadataCollection represented by a guid.
`MetadataRepositoryCohort`	`updateMetadataRepositoryCohort(String userId, MetadataRepositoryCohort metadataRepositoryCohort)` Update metadataRepositoryCohort
`MetadataRepositoryCohort`	`updateMetadataRepositoryCohortClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing metadataRepositoryCohort represented by a guid.
`NestedFile`	`updateNestedFileRelationship(String userId, NestedFile nestedFile)` Update NestedFile relationship
`NestedLocation`	`updateNestedLocationRelationship(String userId, NestedLocation nestedLocation)` Update NestedLocation relationship
`Network`	`updateNetwork(String userId, Network network)` Update network
`Network`	`updateNetworkClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing network represented by a guid.
`NetworkGateway`	`updateNetworkGateway(String userId, NetworkGateway networkGateway)` Update networkGateway
`NetworkGateway`	`updateNetworkGatewayClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing networkGateway represented by a guid.
`NetworkGatewayLink`	`updateNetworkGatewayLinkRelationship(String userId, NetworkGatewayLink networkGatewayLink)` Update NetworkGatewayLink relationship
`NoteEntry`	`updateNoteEntry(String userId, NoteEntry noteEntry)` Update noteEntry
`NoteEntry`	`updateNoteEntryClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing noteEntry represented by a guid.
`NoteLog`	`updateNoteLog(String userId, NoteLog noteLog)` Update noteLog
`NoteLog`	`updateNoteLogClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing noteLog represented by a guid.
`OperatingPlatform`	`updateOperatingPlatform(String userId, OperatingPlatform operatingPlatform)` Update operatingPlatform
`OperatingPlatform`	`updateOperatingPlatformClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing operatingPlatform represented by a guid.
`OrganizationalCapability`	`updateOrganizationalCapabilityRelationship(String userId, OrganizationalCapability organizationalCapability)` Update OrganizationalCapability relationship
`Peer`	`updatePeerRelationship(String userId, Peer peer)` Update Peer relationship
`Person`	`updatePerson(String userId, Person person)` Update person
`Person`	`updatePersonClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing person represented by a guid.
`PreferredTerm`	`updatePreferredTermRelationship(String userId, PreferredTerm preferredTerm)` Update PreferredTerm relationship
`Process`	`updateProcess(String userId, Process process)` Update process
`Process`	`updateProcessClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing process represented by a guid.
`ProcessInput`	`updateProcessInputRelationship(String userId, ProcessInput processInput)` Update ProcessInput relationship
`ProcessOutput`	`updateProcessOutputRelationship(String userId, ProcessOutput processOutput)` Update ProcessOutput relationship
`ProfileIdentity`	`updateProfileIdentityRelationship(String userId, ProfileIdentity profileIdentity)` Update ProfileIdentity relationship
`Project`	`updateProject(String userId, Project project)` Update project
`ProjectCharter`	`updateProjectCharter(String userId, ProjectCharter projectCharter)` Update projectCharter
`ProjectCharter`	`updateProjectCharterClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing projectCharter represented by a guid.
`ProjectCharterLink`	`updateProjectCharterLinkRelationship(String userId, ProjectCharterLink projectCharterLink)` Update ProjectCharterLink relationship
`Project`	`updateProjectClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing project represented by a guid.
`ProjectDependency`	`updateProjectDependencyRelationship(String userId, ProjectDependency projectDependency)` Update ProjectDependency relationship
`ProjectHierarchy`	`updateProjectHierarchyRelationship(String userId, ProjectHierarchy projectHierarchy)` Update ProjectHierarchy relationship
`ProjectScope`	`updateProjectScopeRelationship(String userId, ProjectScope projectScope)` Update ProjectScope relationship
`ProjectTeam`	`updateProjectTeamRelationship(String userId, ProjectTeam projectTeam)` Update ProjectTeam relationship
`PropertyFacet`	`updatePropertyFacet(String userId, PropertyFacet propertyFacet)` Update propertyFacet
`PropertyFacet`	`updatePropertyFacetClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing propertyFacet represented by a guid.
`Rating`	`updateRating(String userId, Rating rating)` Update rating
`Rating`	`updateRatingClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing rating represented by a guid.
`Referenceable`	`updateReferenceable(String userId, Referenceable referenceable)` Update referenceable
`Referenceable`	`updateReferenceableClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing referenceable represented by a guid.
`ReferenceableFacet`	`updateReferenceableFacetRelationship(String userId, ReferenceableFacet referenceableFacet)` Update ReferenceableFacet relationship
`Regulation`	`updateRegulation(String userId, Regulation regulation)` Update regulation
`RegulationCertificationType`	`updateRegulationCertificationTypeRelationship(String userId, RegulationCertificationType regulationCertificationType)` Update RegulationCertificationType relationship
`Regulation`	`updateRegulationClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing regulation represented by a guid.
`RelatedMedia`	`updateRelatedMedia(String userId, RelatedMedia relatedMedia)` Update relatedMedia
`RelatedMedia`	`updateRelatedMediaClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing relatedMedia represented by a guid.
`RelatedTerm`	`updateRelatedTermRelationship(String userId, RelatedTerm relatedTerm)` Update RelatedTerm relationship
`ReplacementTerm`	`updateReplacementTermRelationship(String userId, ReplacementTerm replacementTerm)` Update ReplacementTerm relationship
`ResponsibilityStaffContact`	`updateResponsibilityStaffContactRelationship(String userId, ResponsibilityStaffContact responsibilityStaffContact)` Update ResponsibilityStaffContact relationship
`RuntimeForProcess`	`updateRuntimeForProcessRelationship(String userId, RuntimeForProcess runtimeForProcess)` Update RuntimeForProcess relationship
`SchemaAttribute`	`updateSchemaAttribute(String userId, SchemaAttribute schemaAttribute)` Update schemaAttribute
`SchemaAttribute`	`updateSchemaAttributeClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing schemaAttribute represented by a guid.
`SchemaAttributeType`	`updateSchemaAttributeTypeRelationship(String userId, SchemaAttributeType schemaAttributeType)` Update SchemaAttributeType relationship
`SchemaLinkElement`	`updateSchemaLinkElement(String userId, SchemaLinkElement schemaLinkElement)` Update schemaLinkElement
`SchemaLinkElement`	`updateSchemaLinkElementClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing schemaLinkElement represented by a guid.
`SchemaLinkToType`	`updateSchemaLinkToTypeRelationship(String userId, SchemaLinkToType schemaLinkToType)` Update SchemaLinkToType relationship
`SchemaQueryImplementation`	`updateSchemaQueryImplementationRelationship(String userId, SchemaQueryImplementation schemaQueryImplementation)` Update SchemaQueryImplementation relationship
`SchemaType`	`updateSchemaType(String userId, SchemaType schemaType)` Update schemaType
`SchemaType`	`updateSchemaTypeClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing schemaType represented by a guid.
`SchemaTypeImplementation`	`updateSchemaTypeImplementationRelationship(String userId, SchemaTypeImplementation schemaTypeImplementation)` Update SchemaTypeImplementation relationship
`SemanticAssignment`	`updateSemanticAssignmentRelationship(String userId, SemanticAssignment semanticAssignment)` Update SemanticAssignment relationship
`ServerEndpoint`	`updateServerEndpointRelationship(String userId, ServerEndpoint serverEndpoint)` Update ServerEndpoint relationship
`SoftwareServer`	`updateSoftwareServer(String userId, SoftwareServer softwareServer)` Update softwareServer
`SoftwareServerCapability`	`updateSoftwareServerCapability(String userId, SoftwareServerCapability softwareServerCapability)` Update softwareServerCapability
`SoftwareServerCapability`	`updateSoftwareServerCapabilityClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing softwareServerCapability represented by a guid.
`SoftwareServer`	`updateSoftwareServerClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing softwareServer represented by a guid.
`SoftwareServerPlatform`	`updateSoftwareServerPlatform(String userId, SoftwareServerPlatform softwareServerPlatform)` Update softwareServerPlatform
`SoftwareServerPlatform`	`updateSoftwareServerPlatformClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing softwareServerPlatform represented by a guid.
`SubscriberList`	`updateSubscriberList(String userId, SubscriberList subscriberList)` Update subscriberList
`SubscriberList`	`updateSubscriberListClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing subscriberList represented by a guid.
`Synonym`	`updateSynonymRelationship(String userId, Synonym synonym)` Update Synonym relationship
`Team`	`updateTeam(String userId, Team team)` Update team
`Team`	`updateTeamClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing team represented by a guid.
`TermAnchor`	`updateTermAnchorRelationship(String userId, TermAnchor termAnchor)` Update TermAnchor relationship
`TermCategorization`	`updateTermCategorizationRelationship(String userId, TermCategorization termCategorization)` Update TermCategorization relationship
`TermHASARelationship`	`updateTermHASARelationshipRelationship(String userId, TermHASARelationship termHASARelationship)` Update TermHASARelationship relationship
`TermISATypeOFRelationship`	`updateTermISATypeOFRelationshipRelationship(String userId, TermISATypeOFRelationship termISATypeOFRelationship)` Update TermISATypeOFRelationship relationship
`TermTYPEDBYRelationship`	`updateTermTYPEDBYRelationshipRelationship(String userId, TermTYPEDBYRelationship termTYPEDBYRelationship)` Update TermTYPEDBYRelationship relationship
`ToDo`	`updateToDo(String userId, ToDo toDo)` Update toDo
`ToDo`	`updateToDoClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing toDo represented by a guid.
`ToDoSource`	`updateToDoSourceRelationship(String userId, ToDoSource toDoSource)` Update ToDoSource relationship
`Topic`	`updateTopic(String userId, Topic topic)` Update topic
`Topic`	`updateTopicClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing topic represented by a guid.
`TopicSubscribers`	`updateTopicSubscribersRelationship(String userId, TopicSubscribers topicSubscribers)` Update TopicSubscribers relationship
`Translation`	`updateTranslationRelationship(String userId, Translation translation)` Update Translation relationship
`UsedInContext`	`updateUsedInContextRelationship(String userId, UsedInContext usedInContext)` Update UsedInContext relationship
`UserIdentity`	`updateUserIdentity(String userId, UserIdentity userIdentity)` Update userIdentity
`UserIdentity`	`updateUserIdentityClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing userIdentity represented by a guid.
`ValidValue`	`updateValidValueRelationship(String userId, ValidValue validValue)` Update ValidValue relationship
`VirtualConnection`	`updateVirtualConnection(String userId, VirtualConnection virtualConnection)` Update virtualConnection
`VirtualConnection`	`updateVirtualConnectionClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing virtualConnection represented by a guid.
`VirtualContainer`	`updateVirtualContainer(String userId, VirtualContainer virtualContainer)` Update virtualContainer
`VirtualContainer`	`updateVirtualContainerClassification(String userId, String entityGuid, List<Classification> classificationsToUpdate)` Updates classifications to an existing virtualContainer represented by a guid.
`ZoneGovernance`	`updateZoneGovernanceRelationship(String userId, ZoneGovernance zoneGovernance)` Update ZoneGovernance relationship

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- SubjectAreaBeansToAccessOMRS
```
public SubjectAreaBeansToAccessOMRS()
```

Method Detail

setOMRSAPIHelper

public void setOMRSAPIHelper(OMRSAPIHelper oMRSAPIHelper)

getCertificationTypeById
```
public CertificationType getCertificationTypeById(String userId,
                                                  String entityGuid)
                                           throws MetadataServerUncontactableException,
                                                  UserNotAuthorizedException,
                                                  InvalidParameterException,
                                                  UnrecognizedGUIDException
```
Fetch complete definition of an certificationType given its GUID. The limit and offset paging parameters limit the number elements returned in each of the certificationTypes relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

CertificationType the CertificationType entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createCertificationType

public CertificationType createCertificationType(String userId,
                                                 CertificationType certificationType)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 ClassificationException,
                                                 StatusNotSupportedException

Create new certificationType.

Parameters:: userId - user identity; certificationType - the input entity with values.
Returns:: CertificationType the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateCertificationType

public CertificationType updateCertificationType(String userId,
                                                 CertificationType certificationType)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 UnrecognizedGUIDException

Update certificationType

Parameters:: userId - user identity; certificationType - certificationType to update
Returns:: CertificationType the updated certificationType entity
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteCertificationTypeByGuid
```
public EntityDetail deleteCertificationTypeByGuid(String userId,
                                                  String entityGuid)
                                           throws MetadataServerUncontactableException,
                                                  UserNotAuthorizedException,
                                                  FunctionNotSupportedException,
                                                  InvalidParameterException,
                                                  UnrecognizedGUIDException
```
Delete an certificationType identified by its GUID. Delete is a soft delete, this means that the certificationType has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the certificationType

Returns:

CertificationType the deleted CertificationType entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeCertificationTypeByGuid
```
public void purgeCertificationTypeByGuid(String userId,
                                         String entityGuid)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         InvalidParameterException,
                                         UnrecognizedGUIDException,
                                         EntityNotDeletedException,
                                         GUIDNotPurgedException
```
Purge an certificationType identified by its GUID. Delete is a hard delete, this means that the certificationType is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the certificationType

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreCertificationType
```
public CertificationType restoreCertificationType(String userId,
                                                  String entityGuid)
                                           throws MetadataServerUncontactableException,
                                                  UserNotAuthorizedException,
                                                  InvalidParameterException,
                                                  UnrecognizedGUIDException,
                                                  GUIDNotDeletedException,
                                                  FunctionNotSupportedException
```
Restore an CertificationType identified by its GUID. Restore resurrects a soft deleted CertificationType. When a CertificationType was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the CertificationType

Returns:

CertificationType the restored CertificationType

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the CertificationType is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addCertificationTypeClassifications

public CertificationType addCertificationTypeClassifications(String userId,
                                                             String entityGuid,
                                                             List<Classification> classifications)
                                                      throws MetadataServerUncontactableException,
                                                             UserNotAuthorizedException,
                                                             InvalidParameterException,
                                                             ClassificationException,
                                                             UnrecognizedGUIDException

Add classifications to the supplied certificationType

Parameters:: userId - user identity; entityGuid - the GUID value for certificationType; classifications - the classifications to apply.
Returns:: the certificationType entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateCertificationTypeClassification

public CertificationType updateCertificationTypeClassification(String userId,
                                                               String entityGuid,
                                                               List<Classification> classificationsToUpdate)
                                                        throws MetadataServerUncontactableException,
                                                               UserNotAuthorizedException,
                                                               InvalidParameterException,
                                                               ClassificationException,
                                                               UnrecognizedGUIDException

Updates classifications to an existing certificationType represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the certificationType; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given certificationType guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteCertificationTypeClassification

public CertificationType deleteCertificationTypeClassification(String userId,
                                                               String entityGuid,
                                                               String name)
                                                        throws MetadataServerUncontactableException,
                                                               UserNotAuthorizedException,
                                                               InvalidParameterException,
                                                               ClassificationException,
                                                               UnrecognizedGUIDException

Deletes a given classification from an existing certificationType represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the certificationType; name - name of the classification
Returns:: deleted CertificationType classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getCertificationTypeRelationships
```
public Set<Line> getCertificationTypeRelationships(String userId,
                                                   String entityGuid,
                                                   String relationshipTypeGuid,
                                                   int fromRelationshipElement,
                                                   Date asOfTime,
                                                   String sequencingProperty,
                                                   SequencingOrder sequencingOrder,
                                                   int pageSize)
                                            throws MetadataServerUncontactableException,
                                                   UserNotAuthorizedException,
                                                   InvalidParameterException,
                                                   FunctionNotSupportedException,
                                                   UnrecognizedGUIDException
```
Get the relationships associated with entity certificationType represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the certificationType

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getAPISchemaTypeById
```
public APISchemaType getAPISchemaTypeById(String userId,
                                          String entityGuid)
                                   throws MetadataServerUncontactableException,
                                          UserNotAuthorizedException,
                                          InvalidParameterException,
                                          UnrecognizedGUIDException
```
Fetch complete definition of an aPISchemaType given its GUID. The limit and offset paging parameters limit the number elements returned in each of the aPISchemaTypes relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

APISchemaType the APISchemaType entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createAPISchemaType

public APISchemaType createAPISchemaType(String userId,
                                         APISchemaType aPISchemaType)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         InvalidParameterException,
                                         ClassificationException,
                                         StatusNotSupportedException

Create new aPISchemaType.

Parameters:: userId - user identity; aPISchemaType - the input entity with values.
Returns:: APISchemaType the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateAPISchemaType
```
public APISchemaType updateAPISchemaType(String userId,
                                         APISchemaType aPISchemaType)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         InvalidParameterException,
                                         UnrecognizedGUIDException
```
Update aPISchemaType

Parameters:

userId - user identity

aPISchemaType - aPISchemaType to update

Returns:

APISchemaType the updated aPISchemaType entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteAPISchemaTypeByGuid
```
public EntityDetail deleteAPISchemaTypeByGuid(String userId,
                                              String entityGuid)
                                       throws MetadataServerUncontactableException,
                                              UserNotAuthorizedException,
                                              FunctionNotSupportedException,
                                              InvalidParameterException,
                                              UnrecognizedGUIDException
```
Delete an aPISchemaType identified by its GUID. Delete is a soft delete, this means that the aPISchemaType has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the aPISchemaType

Returns:

APISchemaType the deleted APISchemaType entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeAPISchemaTypeByGuid
```
public void purgeAPISchemaTypeByGuid(String userId,
                                     String entityGuid)
                              throws MetadataServerUncontactableException,
                                     UserNotAuthorizedException,
                                     InvalidParameterException,
                                     UnrecognizedGUIDException,
                                     EntityNotDeletedException,
                                     GUIDNotPurgedException
```
Purge an aPISchemaType identified by its GUID. Delete is a hard delete, this means that the aPISchemaType is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the aPISchemaType

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreAPISchemaType
```
public APISchemaType restoreAPISchemaType(String userId,
                                          String entityGuid)
                                   throws MetadataServerUncontactableException,
                                          UserNotAuthorizedException,
                                          InvalidParameterException,
                                          UnrecognizedGUIDException,
                                          GUIDNotDeletedException,
                                          FunctionNotSupportedException
```
Restore an APISchemaType identified by its GUID. Restore resurrects a soft deleted APISchemaType. When a APISchemaType was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the APISchemaType

Returns:

APISchemaType the restored APISchemaType

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the APISchemaType is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addAPISchemaTypeClassifications

public APISchemaType addAPISchemaTypeClassifications(String userId,
                                                     String entityGuid,
                                                     List<Classification> classifications)
                                              throws MetadataServerUncontactableException,
                                                     UserNotAuthorizedException,
                                                     InvalidParameterException,
                                                     ClassificationException,
                                                     UnrecognizedGUIDException

Add classifications to the supplied aPISchemaType

Parameters:: userId - user identity; entityGuid - the GUID value for aPISchemaType; classifications - the classifications to apply.
Returns:: the aPISchemaType entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateAPISchemaTypeClassification

public APISchemaType updateAPISchemaTypeClassification(String userId,
                                                       String entityGuid,
                                                       List<Classification> classificationsToUpdate)
                                                throws MetadataServerUncontactableException,
                                                       UserNotAuthorizedException,
                                                       InvalidParameterException,
                                                       ClassificationException,
                                                       UnrecognizedGUIDException

Updates classifications to an existing aPISchemaType represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the aPISchemaType; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given aPISchemaType guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteAPISchemaTypeClassification

public APISchemaType deleteAPISchemaTypeClassification(String userId,
                                                       String entityGuid,
                                                       String name)
                                                throws MetadataServerUncontactableException,
                                                       UserNotAuthorizedException,
                                                       InvalidParameterException,
                                                       ClassificationException,
                                                       UnrecognizedGUIDException

Deletes a given classification from an existing aPISchemaType represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the aPISchemaType; name - name of the classification
Returns:: deleted APISchemaType classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getAPISchemaTypeRelationships
```
public Set<Line> getAPISchemaTypeRelationships(String userId,
                                               String entityGuid,
                                               String relationshipTypeGuid,
                                               int fromRelationshipElement,
                                               Date asOfTime,
                                               String sequencingProperty,
                                               SequencingOrder sequencingOrder,
                                               int pageSize)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               InvalidParameterException,
                                               FunctionNotSupportedException,
                                               UnrecognizedGUIDException
```
Get the relationships associated with entity aPISchemaType represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the aPISchemaType

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getDataSetById
```
public DataSet getDataSetById(String userId,
                              String entityGuid)
                       throws MetadataServerUncontactableException,
                              UserNotAuthorizedException,
                              InvalidParameterException,
                              UnrecognizedGUIDException
```
Fetch complete definition of an dataSet given its GUID. The limit and offset paging parameters limit the number elements returned in each of the dataSets relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

DataSet the DataSet entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createDataSet

public DataSet createDataSet(String userId,
                             DataSet dataSet)
                      throws MetadataServerUncontactableException,
                             UserNotAuthorizedException,
                             InvalidParameterException,
                             ClassificationException,
                             StatusNotSupportedException

Create new dataSet.

Parameters:: userId - user identity; dataSet - the input entity with values.
Returns:: DataSet the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateDataSet
```
public DataSet updateDataSet(String userId,
                             DataSet dataSet)
                      throws MetadataServerUncontactableException,
                             UserNotAuthorizedException,
                             InvalidParameterException,
                             UnrecognizedGUIDException
```
Update dataSet

Parameters:

userId - user identity

dataSet - dataSet to update

Returns:

DataSet the updated dataSet entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteDataSetByGuid
```
public EntityDetail deleteDataSetByGuid(String userId,
                                        String entityGuid)
                                 throws MetadataServerUncontactableException,
                                        UserNotAuthorizedException,
                                        FunctionNotSupportedException,
                                        InvalidParameterException,
                                        UnrecognizedGUIDException
```
Delete an dataSet identified by its GUID. Delete is a soft delete, this means that the dataSet has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the dataSet

Returns:

DataSet the deleted DataSet entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeDataSetByGuid
```
public void purgeDataSetByGuid(String userId,
                               String entityGuid)
                        throws MetadataServerUncontactableException,
                               UserNotAuthorizedException,
                               InvalidParameterException,
                               UnrecognizedGUIDException,
                               EntityNotDeletedException,
                               GUIDNotPurgedException
```
Purge an dataSet identified by its GUID. Delete is a hard delete, this means that the dataSet is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the dataSet

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreDataSet
```
public DataSet restoreDataSet(String userId,
                              String entityGuid)
                       throws MetadataServerUncontactableException,
                              UserNotAuthorizedException,
                              InvalidParameterException,
                              UnrecognizedGUIDException,
                              GUIDNotDeletedException,
                              FunctionNotSupportedException
```
Restore an DataSet identified by its GUID. Restore resurrects a soft deleted DataSet. When a DataSet was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the DataSet

Returns:

DataSet the restored DataSet

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the DataSet is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addDataSetClassifications

public DataSet addDataSetClassifications(String userId,
                                         String entityGuid,
                                         List<Classification> classifications)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         InvalidParameterException,
                                         ClassificationException,
                                         UnrecognizedGUIDException

Add classifications to the supplied dataSet

Parameters:: userId - user identity; entityGuid - the GUID value for dataSet; classifications - the classifications to apply.
Returns:: the dataSet entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateDataSetClassification

public DataSet updateDataSetClassification(String userId,
                                           String entityGuid,
                                           List<Classification> classificationsToUpdate)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           InvalidParameterException,
                                           ClassificationException,
                                           UnrecognizedGUIDException

Updates classifications to an existing dataSet represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the dataSet; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given dataSet guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteDataSetClassification

public DataSet deleteDataSetClassification(String userId,
                                           String entityGuid,
                                           String name)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           InvalidParameterException,
                                           ClassificationException,
                                           UnrecognizedGUIDException

Deletes a given classification from an existing dataSet represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the dataSet; name - name of the classification
Returns:: deleted DataSet classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getDataSetRelationships
```
public Set<Line> getDataSetRelationships(String userId,
                                         String entityGuid,
                                         String relationshipTypeGuid,
                                         int fromRelationshipElement,
                                         Date asOfTime,
                                         String sequencingProperty,
                                         SequencingOrder sequencingOrder,
                                         int pageSize)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         InvalidParameterException,
                                         FunctionNotSupportedException,
                                         UnrecognizedGUIDException
```
Get the relationships associated with entity dataSet represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the dataSet

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getOperatingPlatformById
```
public OperatingPlatform getOperatingPlatformById(String userId,
                                                  String entityGuid)
                                           throws MetadataServerUncontactableException,
                                                  UserNotAuthorizedException,
                                                  InvalidParameterException,
                                                  UnrecognizedGUIDException
```
Fetch complete definition of an operatingPlatform given its GUID. The limit and offset paging parameters limit the number elements returned in each of the operatingPlatforms relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

OperatingPlatform the OperatingPlatform entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createOperatingPlatform

public OperatingPlatform createOperatingPlatform(String userId,
                                                 OperatingPlatform operatingPlatform)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 ClassificationException,
                                                 StatusNotSupportedException

Create new operatingPlatform.

Parameters:: userId - user identity; operatingPlatform - the input entity with values.
Returns:: OperatingPlatform the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateOperatingPlatform

public OperatingPlatform updateOperatingPlatform(String userId,
                                                 OperatingPlatform operatingPlatform)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 UnrecognizedGUIDException

Update operatingPlatform

Parameters:: userId - user identity; operatingPlatform - operatingPlatform to update
Returns:: OperatingPlatform the updated operatingPlatform entity
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteOperatingPlatformByGuid
```
public EntityDetail deleteOperatingPlatformByGuid(String userId,
                                                  String entityGuid)
                                           throws MetadataServerUncontactableException,
                                                  UserNotAuthorizedException,
                                                  FunctionNotSupportedException,
                                                  InvalidParameterException,
                                                  UnrecognizedGUIDException
```
Delete an operatingPlatform identified by its GUID. Delete is a soft delete, this means that the operatingPlatform has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the operatingPlatform

Returns:

OperatingPlatform the deleted OperatingPlatform entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeOperatingPlatformByGuid
```
public void purgeOperatingPlatformByGuid(String userId,
                                         String entityGuid)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         InvalidParameterException,
                                         UnrecognizedGUIDException,
                                         EntityNotDeletedException,
                                         GUIDNotPurgedException
```
Purge an operatingPlatform identified by its GUID. Delete is a hard delete, this means that the operatingPlatform is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the operatingPlatform

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreOperatingPlatform
```
public OperatingPlatform restoreOperatingPlatform(String userId,
                                                  String entityGuid)
                                           throws MetadataServerUncontactableException,
                                                  UserNotAuthorizedException,
                                                  InvalidParameterException,
                                                  UnrecognizedGUIDException,
                                                  GUIDNotDeletedException,
                                                  FunctionNotSupportedException
```
Restore an OperatingPlatform identified by its GUID. Restore resurrects a soft deleted OperatingPlatform. When a OperatingPlatform was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the OperatingPlatform

Returns:

OperatingPlatform the restored OperatingPlatform

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the OperatingPlatform is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addOperatingPlatformClassifications

public OperatingPlatform addOperatingPlatformClassifications(String userId,
                                                             String entityGuid,
                                                             List<Classification> classifications)
                                                      throws MetadataServerUncontactableException,
                                                             UserNotAuthorizedException,
                                                             InvalidParameterException,
                                                             ClassificationException,
                                                             UnrecognizedGUIDException

Add classifications to the supplied operatingPlatform

Parameters:: userId - user identity; entityGuid - the GUID value for operatingPlatform; classifications - the classifications to apply.
Returns:: the operatingPlatform entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateOperatingPlatformClassification

public OperatingPlatform updateOperatingPlatformClassification(String userId,
                                                               String entityGuid,
                                                               List<Classification> classificationsToUpdate)
                                                        throws MetadataServerUncontactableException,
                                                               UserNotAuthorizedException,
                                                               InvalidParameterException,
                                                               ClassificationException,
                                                               UnrecognizedGUIDException

Updates classifications to an existing operatingPlatform represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the operatingPlatform; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given operatingPlatform guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteOperatingPlatformClassification

public OperatingPlatform deleteOperatingPlatformClassification(String userId,
                                                               String entityGuid,
                                                               String name)
                                                        throws MetadataServerUncontactableException,
                                                               UserNotAuthorizedException,
                                                               InvalidParameterException,
                                                               ClassificationException,
                                                               UnrecognizedGUIDException

Deletes a given classification from an existing operatingPlatform represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the operatingPlatform; name - name of the classification
Returns:: deleted OperatingPlatform classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getOperatingPlatformRelationships
```
public Set<Line> getOperatingPlatformRelationships(String userId,
                                                   String entityGuid,
                                                   String relationshipTypeGuid,
                                                   int fromRelationshipElement,
                                                   Date asOfTime,
                                                   String sequencingProperty,
                                                   SequencingOrder sequencingOrder,
                                                   int pageSize)
                                            throws MetadataServerUncontactableException,
                                                   UserNotAuthorizedException,
                                                   InvalidParameterException,
                                                   FunctionNotSupportedException,
                                                   UnrecognizedGUIDException
```
Get the relationships associated with entity operatingPlatform represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the operatingPlatform

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getGovernancePolicyById
```
public GovernancePolicy getGovernancePolicyById(String userId,
                                                String entityGuid)
                                         throws MetadataServerUncontactableException,
                                                UserNotAuthorizedException,
                                                InvalidParameterException,
                                                UnrecognizedGUIDException
```
Fetch complete definition of an governancePolicy given its GUID. The limit and offset paging parameters limit the number elements returned in each of the governancePolicies relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

GovernancePolicy the GovernancePolicy entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createGovernancePolicy

public GovernancePolicy createGovernancePolicy(String userId,
                                               GovernancePolicy governancePolicy)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               InvalidParameterException,
                                               ClassificationException,
                                               StatusNotSupportedException

Create new governancePolicy.

Parameters:: userId - user identity; governancePolicy - the input entity with values.
Returns:: GovernancePolicy the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateGovernancePolicy

public GovernancePolicy updateGovernancePolicy(String userId,
                                               GovernancePolicy governancePolicy)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               InvalidParameterException,
                                               UnrecognizedGUIDException

Update governancePolicy

Parameters:: userId - user identity; governancePolicy - governancePolicy to update
Returns:: GovernancePolicy the updated governancePolicy entity
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteGovernancePolicyByGuid
```
public EntityDetail deleteGovernancePolicyByGuid(String userId,
                                                 String entityGuid)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 FunctionNotSupportedException,
                                                 InvalidParameterException,
                                                 UnrecognizedGUIDException
```
Delete an governancePolicy identified by its GUID. Delete is a soft delete, this means that the governancePolicy has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the governancePolicy

Returns:

GovernancePolicy the deleted GovernancePolicy entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeGovernancePolicyByGuid
```
public void purgeGovernancePolicyByGuid(String userId,
                                        String entityGuid)
                                 throws MetadataServerUncontactableException,
                                        UserNotAuthorizedException,
                                        InvalidParameterException,
                                        UnrecognizedGUIDException,
                                        EntityNotDeletedException,
                                        GUIDNotPurgedException
```
Purge an governancePolicy identified by its GUID. Delete is a hard delete, this means that the governancePolicy is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the governancePolicy

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreGovernancePolicy
```
public GovernancePolicy restoreGovernancePolicy(String userId,
                                                String entityGuid)
                                         throws MetadataServerUncontactableException,
                                                UserNotAuthorizedException,
                                                InvalidParameterException,
                                                UnrecognizedGUIDException,
                                                GUIDNotDeletedException,
                                                FunctionNotSupportedException
```
Restore an GovernancePolicy identified by its GUID. Restore resurrects a soft deleted GovernancePolicy. When a GovernancePolicy was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the GovernancePolicy

Returns:

GovernancePolicy the restored GovernancePolicy

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the GovernancePolicy is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addGovernancePolicyClassifications

public GovernancePolicy addGovernancePolicyClassifications(String userId,
                                                           String entityGuid,
                                                           List<Classification> classifications)
                                                    throws MetadataServerUncontactableException,
                                                           UserNotAuthorizedException,
                                                           InvalidParameterException,
                                                           ClassificationException,
                                                           UnrecognizedGUIDException

Add classifications to the supplied governancePolicy

Parameters:: userId - user identity; entityGuid - the GUID value for governancePolicy; classifications - the classifications to apply.
Returns:: the governancePolicy entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateGovernancePolicyClassification

public GovernancePolicy updateGovernancePolicyClassification(String userId,
                                                             String entityGuid,
                                                             List<Classification> classificationsToUpdate)
                                                      throws MetadataServerUncontactableException,
                                                             UserNotAuthorizedException,
                                                             InvalidParameterException,
                                                             ClassificationException,
                                                             UnrecognizedGUIDException

Updates classifications to an existing governancePolicy represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the governancePolicy; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given governancePolicy guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteGovernancePolicyClassification

public GovernancePolicy deleteGovernancePolicyClassification(String userId,
                                                             String entityGuid,
                                                             String name)
                                                      throws MetadataServerUncontactableException,
                                                             UserNotAuthorizedException,
                                                             InvalidParameterException,
                                                             ClassificationException,
                                                             UnrecognizedGUIDException

Deletes a given classification from an existing governancePolicy represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the governancePolicy; name - name of the classification
Returns:: deleted GovernancePolicy classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getGovernancePolicyRelationships
```
public Set<Line> getGovernancePolicyRelationships(String userId,
                                                  String entityGuid,
                                                  String relationshipTypeGuid,
                                                  int fromRelationshipElement,
                                                  Date asOfTime,
                                                  String sequencingProperty,
                                                  SequencingOrder sequencingOrder,
                                                  int pageSize)
                                           throws MetadataServerUncontactableException,
                                                  UserNotAuthorizedException,
                                                  InvalidParameterException,
                                                  FunctionNotSupportedException,
                                                  UnrecognizedGUIDException
```
Get the relationships associated with entity governancePolicy represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the governancePolicy

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getDerivedSchemaAttributeById
```
public DerivedSchemaAttribute getDerivedSchemaAttributeById(String userId,
                                                            String entityGuid)
                                                     throws MetadataServerUncontactableException,
                                                            UserNotAuthorizedException,
                                                            InvalidParameterException,
                                                            UnrecognizedGUIDException
```
Fetch complete definition of an derivedSchemaAttribute given its GUID. The limit and offset paging parameters limit the number elements returned in each of the derivedSchemaAttributes relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

DerivedSchemaAttribute the DerivedSchemaAttribute entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createDerivedSchemaAttribute

public DerivedSchemaAttribute createDerivedSchemaAttribute(String userId,
                                                           DerivedSchemaAttribute derivedSchemaAttribute)
                                                    throws MetadataServerUncontactableException,
                                                           UserNotAuthorizedException,
                                                           InvalidParameterException,
                                                           ClassificationException,
                                                           StatusNotSupportedException

Create new derivedSchemaAttribute.

Parameters:: userId - user identity; derivedSchemaAttribute - the input entity with values.
Returns:: DerivedSchemaAttribute the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateDerivedSchemaAttribute

public DerivedSchemaAttribute updateDerivedSchemaAttribute(String userId,
                                                           DerivedSchemaAttribute derivedSchemaAttribute)
                                                    throws MetadataServerUncontactableException,
                                                           UserNotAuthorizedException,
                                                           InvalidParameterException,
                                                           UnrecognizedGUIDException

Update derivedSchemaAttribute

Parameters:: userId - user identity; derivedSchemaAttribute - derivedSchemaAttribute to update
Returns:: DerivedSchemaAttribute the updated derivedSchemaAttribute entity
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteDerivedSchemaAttributeByGuid
```
public EntityDetail deleteDerivedSchemaAttributeByGuid(String userId,
                                                       String entityGuid)
                                                throws MetadataServerUncontactableException,
                                                       UserNotAuthorizedException,
                                                       FunctionNotSupportedException,
                                                       InvalidParameterException,
                                                       UnrecognizedGUIDException
```
Delete an derivedSchemaAttribute identified by its GUID. Delete is a soft delete, this means that the derivedSchemaAttribute has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the derivedSchemaAttribute

Returns:

DerivedSchemaAttribute the deleted DerivedSchemaAttribute entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeDerivedSchemaAttributeByGuid

public void purgeDerivedSchemaAttributeByGuid(String userId,
                                              String entityGuid)
                                       throws MetadataServerUncontactableException,
                                              UserNotAuthorizedException,
                                              InvalidParameterException,
                                              UnrecognizedGUIDException,
                                              EntityNotDeletedException,
                                              GUIDNotPurgedException

Purge an derivedSchemaAttribute identified by its GUID. Delete is a hard delete, this means that the derivedSchemaAttribute is really deleted .

Parameters:: userId - user identity; entityGuid - GUID for the derivedSchemaAttribute
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; EntityNotDeletedException - the entity was not deleted; GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreDerivedSchemaAttribute

public DerivedSchemaAttribute restoreDerivedSchemaAttribute(String userId,
                                                            String entityGuid)
                                                     throws MetadataServerUncontactableException,
                                                            UserNotAuthorizedException,
                                                            InvalidParameterException,
                                                            UnrecognizedGUIDException,
                                                            GUIDNotDeletedException,
                                                            FunctionNotSupportedException

Restore an DerivedSchemaAttribute identified by its GUID. Restore resurrects a soft deleted DerivedSchemaAttribute. When a DerivedSchemaAttribute was incorrectly deleted, the delete can be undone using the restore..

Parameters:: userId - user identity; entityGuid - GUID for the DerivedSchemaAttribute
Returns:: DerivedSchemaAttribute the restored DerivedSchemaAttribute
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; GUIDNotDeletedException - the guid of the DerivedSchemaAttribute is not deleted, so cannot be restored; FunctionNotSupportedException - Function not supported

addDerivedSchemaAttributeClassifications

public DerivedSchemaAttribute addDerivedSchemaAttributeClassifications(String userId,
                                                                       String entityGuid,
                                                                       List<Classification> classifications)
                                                                throws MetadataServerUncontactableException,
                                                                       UserNotAuthorizedException,
                                                                       InvalidParameterException,
                                                                       ClassificationException,
                                                                       UnrecognizedGUIDException

Add classifications to the supplied derivedSchemaAttribute

Parameters:: userId - user identity; entityGuid - the GUID value for derivedSchemaAttribute; classifications - the classifications to apply.
Returns:: the derivedSchemaAttribute entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateDerivedSchemaAttributeClassification

public DerivedSchemaAttribute updateDerivedSchemaAttributeClassification(String userId,
                                                                         String entityGuid,
                                                                         List<Classification> classificationsToUpdate)
                                                                  throws MetadataServerUncontactableException,
                                                                         UserNotAuthorizedException,
                                                                         InvalidParameterException,
                                                                         ClassificationException,
                                                                         UnrecognizedGUIDException

Updates classifications to an existing derivedSchemaAttribute represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the derivedSchemaAttribute; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given derivedSchemaAttribute guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteDerivedSchemaAttributeClassification

public DerivedSchemaAttribute deleteDerivedSchemaAttributeClassification(String userId,
                                                                         String entityGuid,
                                                                         String name)
                                                                  throws MetadataServerUncontactableException,
                                                                         UserNotAuthorizedException,
                                                                         InvalidParameterException,
                                                                         ClassificationException,
                                                                         UnrecognizedGUIDException

Deletes a given classification from an existing derivedSchemaAttribute represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the derivedSchemaAttribute; name - name of the classification
Returns:: deleted DerivedSchemaAttribute classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getDerivedSchemaAttributeRelationships
```
public Set<Line> getDerivedSchemaAttributeRelationships(String userId,
                                                        String entityGuid,
                                                        String relationshipTypeGuid,
                                                        int fromRelationshipElement,
                                                        Date asOfTime,
                                                        String sequencingProperty,
                                                        SequencingOrder sequencingOrder,
                                                        int pageSize)
                                                 throws MetadataServerUncontactableException,
                                                        UserNotAuthorizedException,
                                                        InvalidParameterException,
                                                        FunctionNotSupportedException,
                                                        UnrecognizedGUIDException
```
Get the relationships associated with entity derivedSchemaAttribute represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the derivedSchemaAttribute

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getProcessById
```
public Process getProcessById(String userId,
                              String entityGuid)
                       throws MetadataServerUncontactableException,
                              UserNotAuthorizedException,
                              InvalidParameterException,
                              UnrecognizedGUIDException
```
Fetch complete definition of an process given its GUID. The limit and offset paging parameters limit the number elements returned in each of the processes relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

Process the Process entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createProcess

public Process createProcess(String userId,
                             Process process)
                      throws MetadataServerUncontactableException,
                             UserNotAuthorizedException,
                             InvalidParameterException,
                             ClassificationException,
                             StatusNotSupportedException

Create new process.

Parameters:: userId - user identity; process - the input entity with values.
Returns:: Process the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateProcess
```
public Process updateProcess(String userId,
                             Process process)
                      throws MetadataServerUncontactableException,
                             UserNotAuthorizedException,
                             InvalidParameterException,
                             UnrecognizedGUIDException
```
Update process

Parameters:

userId - user identity

process - process to update

Returns:

Process the updated process entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteProcessByGuid
```
public EntityDetail deleteProcessByGuid(String userId,
                                        String entityGuid)
                                 throws MetadataServerUncontactableException,
                                        UserNotAuthorizedException,
                                        FunctionNotSupportedException,
                                        InvalidParameterException,
                                        UnrecognizedGUIDException
```
Delete an process identified by its GUID. Delete is a soft delete, this means that the process has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the process

Returns:

Process the deleted Process entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeProcessByGuid
```
public void purgeProcessByGuid(String userId,
                               String entityGuid)
                        throws MetadataServerUncontactableException,
                               UserNotAuthorizedException,
                               InvalidParameterException,
                               UnrecognizedGUIDException,
                               EntityNotDeletedException,
                               GUIDNotPurgedException
```
Purge an process identified by its GUID. Delete is a hard delete, this means that the process is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the process

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreProcess
```
public Process restoreProcess(String userId,
                              String entityGuid)
                       throws MetadataServerUncontactableException,
                              UserNotAuthorizedException,
                              InvalidParameterException,
                              UnrecognizedGUIDException,
                              GUIDNotDeletedException,
                              FunctionNotSupportedException
```
Restore an Process identified by its GUID. Restore resurrects a soft deleted Process. When a Process was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the Process

Returns:

Process the restored Process

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the Process is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addProcessClassifications

public Process addProcessClassifications(String userId,
                                         String entityGuid,
                                         List<Classification> classifications)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         InvalidParameterException,
                                         ClassificationException,
                                         UnrecognizedGUIDException

Add classifications to the supplied process

Parameters:: userId - user identity; entityGuid - the GUID value for process; classifications - the classifications to apply.
Returns:: the process entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateProcessClassification

public Process updateProcessClassification(String userId,
                                           String entityGuid,
                                           List<Classification> classificationsToUpdate)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           InvalidParameterException,
                                           ClassificationException,
                                           UnrecognizedGUIDException

Updates classifications to an existing process represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the process; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given process guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteProcessClassification

public Process deleteProcessClassification(String userId,
                                           String entityGuid,
                                           String name)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           InvalidParameterException,
                                           ClassificationException,
                                           UnrecognizedGUIDException

Deletes a given classification from an existing process represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the process; name - name of the classification
Returns:: deleted Process classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getProcessRelationships
```
public Set<Line> getProcessRelationships(String userId,
                                         String entityGuid,
                                         String relationshipTypeGuid,
                                         int fromRelationshipElement,
                                         Date asOfTime,
                                         String sequencingProperty,
                                         SequencingOrder sequencingOrder,
                                         int pageSize)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         InvalidParameterException,
                                         FunctionNotSupportedException,
                                         UnrecognizedGUIDException
```
Get the relationships associated with entity process represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the process

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getMapSchemaTypeById
```
public MapSchemaType getMapSchemaTypeById(String userId,
                                          String entityGuid)
                                   throws MetadataServerUncontactableException,
                                          UserNotAuthorizedException,
                                          InvalidParameterException,
                                          UnrecognizedGUIDException
```
Fetch complete definition of an mapSchemaType given its GUID. The limit and offset paging parameters limit the number elements returned in each of the mapSchemaTypes relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

MapSchemaType the MapSchemaType entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createMapSchemaType

public MapSchemaType createMapSchemaType(String userId,
                                         MapSchemaType mapSchemaType)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         InvalidParameterException,
                                         ClassificationException,
                                         StatusNotSupportedException

Create new mapSchemaType.

Parameters:: userId - user identity; mapSchemaType - the input entity with values.
Returns:: MapSchemaType the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateMapSchemaType
```
public MapSchemaType updateMapSchemaType(String userId,
                                         MapSchemaType mapSchemaType)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         InvalidParameterException,
                                         UnrecognizedGUIDException
```
Update mapSchemaType

Parameters:

userId - user identity

mapSchemaType - mapSchemaType to update

Returns:

MapSchemaType the updated mapSchemaType entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteMapSchemaTypeByGuid
```
public EntityDetail deleteMapSchemaTypeByGuid(String userId,
                                              String entityGuid)
                                       throws MetadataServerUncontactableException,
                                              UserNotAuthorizedException,
                                              FunctionNotSupportedException,
                                              InvalidParameterException,
                                              UnrecognizedGUIDException
```
Delete an mapSchemaType identified by its GUID. Delete is a soft delete, this means that the mapSchemaType has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the mapSchemaType

Returns:

MapSchemaType the deleted MapSchemaType entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeMapSchemaTypeByGuid
```
public void purgeMapSchemaTypeByGuid(String userId,
                                     String entityGuid)
                              throws MetadataServerUncontactableException,
                                     UserNotAuthorizedException,
                                     InvalidParameterException,
                                     UnrecognizedGUIDException,
                                     EntityNotDeletedException,
                                     GUIDNotPurgedException
```
Purge an mapSchemaType identified by its GUID. Delete is a hard delete, this means that the mapSchemaType is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the mapSchemaType

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreMapSchemaType
```
public MapSchemaType restoreMapSchemaType(String userId,
                                          String entityGuid)
                                   throws MetadataServerUncontactableException,
                                          UserNotAuthorizedException,
                                          InvalidParameterException,
                                          UnrecognizedGUIDException,
                                          GUIDNotDeletedException,
                                          FunctionNotSupportedException
```
Restore an MapSchemaType identified by its GUID. Restore resurrects a soft deleted MapSchemaType. When a MapSchemaType was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the MapSchemaType

Returns:

MapSchemaType the restored MapSchemaType

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the MapSchemaType is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addMapSchemaTypeClassifications

public MapSchemaType addMapSchemaTypeClassifications(String userId,
                                                     String entityGuid,
                                                     List<Classification> classifications)
                                              throws MetadataServerUncontactableException,
                                                     UserNotAuthorizedException,
                                                     InvalidParameterException,
                                                     ClassificationException,
                                                     UnrecognizedGUIDException

Add classifications to the supplied mapSchemaType

Parameters:: userId - user identity; entityGuid - the GUID value for mapSchemaType; classifications - the classifications to apply.
Returns:: the mapSchemaType entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateMapSchemaTypeClassification

public MapSchemaType updateMapSchemaTypeClassification(String userId,
                                                       String entityGuid,
                                                       List<Classification> classificationsToUpdate)
                                                throws MetadataServerUncontactableException,
                                                       UserNotAuthorizedException,
                                                       InvalidParameterException,
                                                       ClassificationException,
                                                       UnrecognizedGUIDException

Updates classifications to an existing mapSchemaType represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the mapSchemaType; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given mapSchemaType guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteMapSchemaTypeClassification

public MapSchemaType deleteMapSchemaTypeClassification(String userId,
                                                       String entityGuid,
                                                       String name)
                                                throws MetadataServerUncontactableException,
                                                       UserNotAuthorizedException,
                                                       InvalidParameterException,
                                                       ClassificationException,
                                                       UnrecognizedGUIDException

Deletes a given classification from an existing mapSchemaType represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the mapSchemaType; name - name of the classification
Returns:: deleted MapSchemaType classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getMapSchemaTypeRelationships
```
public Set<Line> getMapSchemaTypeRelationships(String userId,
                                               String entityGuid,
                                               String relationshipTypeGuid,
                                               int fromRelationshipElement,
                                               Date asOfTime,
                                               String sequencingProperty,
                                               SequencingOrder sequencingOrder,
                                               int pageSize)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               InvalidParameterException,
                                               FunctionNotSupportedException,
                                               UnrecognizedGUIDException
```
Get the relationships associated with entity mapSchemaType represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the mapSchemaType

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getDeployedSoftwareComponentById
```
public DeployedSoftwareComponent getDeployedSoftwareComponentById(String userId,
                                                                  String entityGuid)
                                                           throws MetadataServerUncontactableException,
                                                                  UserNotAuthorizedException,
                                                                  InvalidParameterException,
                                                                  UnrecognizedGUIDException
```
Fetch complete definition of an deployedSoftwareComponent given its GUID. The limit and offset paging parameters limit the number elements returned in each of the deployedSoftwareComponents relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

DeployedSoftwareComponent the DeployedSoftwareComponent entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createDeployedSoftwareComponent

public DeployedSoftwareComponent createDeployedSoftwareComponent(String userId,
                                                                 DeployedSoftwareComponent deployedSoftwareComponent)
                                                          throws MetadataServerUncontactableException,
                                                                 UserNotAuthorizedException,
                                                                 InvalidParameterException,
                                                                 ClassificationException,
                                                                 StatusNotSupportedException

Create new deployedSoftwareComponent.

Parameters:: userId - user identity; deployedSoftwareComponent - the input entity with values.
Returns:: DeployedSoftwareComponent the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateDeployedSoftwareComponent

public DeployedSoftwareComponent updateDeployedSoftwareComponent(String userId,
                                                                 DeployedSoftwareComponent deployedSoftwareComponent)
                                                          throws MetadataServerUncontactableException,
                                                                 UserNotAuthorizedException,
                                                                 InvalidParameterException,
                                                                 UnrecognizedGUIDException

Update deployedSoftwareComponent

Parameters:: userId - user identity; deployedSoftwareComponent - deployedSoftwareComponent to update
Returns:: DeployedSoftwareComponent the updated deployedSoftwareComponent entity
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteDeployedSoftwareComponentByGuid
```
public EntityDetail deleteDeployedSoftwareComponentByGuid(String userId,
                                                          String entityGuid)
                                                   throws MetadataServerUncontactableException,
                                                          UserNotAuthorizedException,
                                                          FunctionNotSupportedException,
                                                          InvalidParameterException,
                                                          UnrecognizedGUIDException
```
Delete an deployedSoftwareComponent identified by its GUID. Delete is a soft delete, this means that the deployedSoftwareComponent has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the deployedSoftwareComponent

Returns:

DeployedSoftwareComponent the deleted DeployedSoftwareComponent entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeDeployedSoftwareComponentByGuid

public void purgeDeployedSoftwareComponentByGuid(String userId,
                                                 String entityGuid)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 UnrecognizedGUIDException,
                                                 EntityNotDeletedException,
                                                 GUIDNotPurgedException

Purge an deployedSoftwareComponent identified by its GUID. Delete is a hard delete, this means that the deployedSoftwareComponent is really deleted .

Parameters:: userId - user identity; entityGuid - GUID for the deployedSoftwareComponent
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; EntityNotDeletedException - the entity was not deleted; GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreDeployedSoftwareComponent

public DeployedSoftwareComponent restoreDeployedSoftwareComponent(String userId,
                                                                  String entityGuid)
                                                           throws MetadataServerUncontactableException,
                                                                  UserNotAuthorizedException,
                                                                  InvalidParameterException,
                                                                  UnrecognizedGUIDException,
                                                                  GUIDNotDeletedException,
                                                                  FunctionNotSupportedException

Restore an DeployedSoftwareComponent identified by its GUID. Restore resurrects a soft deleted DeployedSoftwareComponent. When a DeployedSoftwareComponent was incorrectly deleted, the delete can be undone using the restore..

Parameters:: userId - user identity; entityGuid - GUID for the DeployedSoftwareComponent
Returns:: DeployedSoftwareComponent the restored DeployedSoftwareComponent
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; GUIDNotDeletedException - the guid of the DeployedSoftwareComponent is not deleted, so cannot be restored; FunctionNotSupportedException - Function not supported

addDeployedSoftwareComponentClassifications

public DeployedSoftwareComponent addDeployedSoftwareComponentClassifications(String userId,
                                                                             String entityGuid,
                                                                             List<Classification> classifications)
                                                                      throws MetadataServerUncontactableException,
                                                                             UserNotAuthorizedException,
                                                                             InvalidParameterException,
                                                                             ClassificationException,
                                                                             UnrecognizedGUIDException

Add classifications to the supplied deployedSoftwareComponent

Parameters:: userId - user identity; entityGuid - the GUID value for deployedSoftwareComponent; classifications - the classifications to apply.
Returns:: the deployedSoftwareComponent entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateDeployedSoftwareComponentClassification

public DeployedSoftwareComponent updateDeployedSoftwareComponentClassification(String userId,
                                                                               String entityGuid,
                                                                               List<Classification> classificationsToUpdate)
                                                                        throws MetadataServerUncontactableException,
                                                                               UserNotAuthorizedException,
                                                                               InvalidParameterException,
                                                                               ClassificationException,
                                                                               UnrecognizedGUIDException

Updates classifications to an existing deployedSoftwareComponent represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the deployedSoftwareComponent; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given deployedSoftwareComponent guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteDeployedSoftwareComponentClassification

public DeployedSoftwareComponent deleteDeployedSoftwareComponentClassification(String userId,
                                                                               String entityGuid,
                                                                               String name)
                                                                        throws MetadataServerUncontactableException,
                                                                               UserNotAuthorizedException,
                                                                               InvalidParameterException,
                                                                               ClassificationException,
                                                                               UnrecognizedGUIDException

Deletes a given classification from an existing deployedSoftwareComponent represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the deployedSoftwareComponent; name - name of the classification
Returns:: deleted DeployedSoftwareComponent classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getDeployedSoftwareComponentRelationships
```
public Set<Line> getDeployedSoftwareComponentRelationships(String userId,
                                                           String entityGuid,
                                                           String relationshipTypeGuid,
                                                           int fromRelationshipElement,
                                                           Date asOfTime,
                                                           String sequencingProperty,
                                                           SequencingOrder sequencingOrder,
                                                           int pageSize)
                                                    throws MetadataServerUncontactableException,
                                                           UserNotAuthorizedException,
                                                           InvalidParameterException,
                                                           FunctionNotSupportedException,
                                                           UnrecognizedGUIDException
```
Get the relationships associated with entity deployedSoftwareComponent represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the deployedSoftwareComponent

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getSchemaTypeById
```
public SchemaType getSchemaTypeById(String userId,
                                    String entityGuid)
                             throws MetadataServerUncontactableException,
                                    UserNotAuthorizedException,
                                    InvalidParameterException,
                                    UnrecognizedGUIDException
```
Fetch complete definition of an schemaType given its GUID. The limit and offset paging parameters limit the number elements returned in each of the schemaTypes relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

SchemaType the SchemaType entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createSchemaType

public SchemaType createSchemaType(String userId,
                                   SchemaType schemaType)
                            throws MetadataServerUncontactableException,
                                   UserNotAuthorizedException,
                                   InvalidParameterException,
                                   ClassificationException,
                                   StatusNotSupportedException

Create new schemaType.

Parameters:: userId - user identity; schemaType - the input entity with values.
Returns:: SchemaType the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateSchemaType
```
public SchemaType updateSchemaType(String userId,
                                   SchemaType schemaType)
                            throws MetadataServerUncontactableException,
                                   UserNotAuthorizedException,
                                   InvalidParameterException,
                                   UnrecognizedGUIDException
```
Update schemaType

Parameters:

userId - user identity

schemaType - schemaType to update

Returns:

SchemaType the updated schemaType entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteSchemaTypeByGuid
```
public EntityDetail deleteSchemaTypeByGuid(String userId,
                                           String entityGuid)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           FunctionNotSupportedException,
                                           InvalidParameterException,
                                           UnrecognizedGUIDException
```
Delete an schemaType identified by its GUID. Delete is a soft delete, this means that the schemaType has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the schemaType

Returns:

SchemaType the deleted SchemaType entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeSchemaTypeByGuid
```
public void purgeSchemaTypeByGuid(String userId,
                                  String entityGuid)
                           throws MetadataServerUncontactableException,
                                  UserNotAuthorizedException,
                                  InvalidParameterException,
                                  UnrecognizedGUIDException,
                                  EntityNotDeletedException,
                                  GUIDNotPurgedException
```
Purge an schemaType identified by its GUID. Delete is a hard delete, this means that the schemaType is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the schemaType

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreSchemaType
```
public SchemaType restoreSchemaType(String userId,
                                    String entityGuid)
                             throws MetadataServerUncontactableException,
                                    UserNotAuthorizedException,
                                    InvalidParameterException,
                                    UnrecognizedGUIDException,
                                    GUIDNotDeletedException,
                                    FunctionNotSupportedException
```
Restore an SchemaType identified by its GUID. Restore resurrects a soft deleted SchemaType. When a SchemaType was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the SchemaType

Returns:

SchemaType the restored SchemaType

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the SchemaType is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addSchemaTypeClassifications

public SchemaType addSchemaTypeClassifications(String userId,
                                               String entityGuid,
                                               List<Classification> classifications)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               InvalidParameterException,
                                               ClassificationException,
                                               UnrecognizedGUIDException

Add classifications to the supplied schemaType

Parameters:: userId - user identity; entityGuid - the GUID value for schemaType; classifications - the classifications to apply.
Returns:: the schemaType entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateSchemaTypeClassification

public SchemaType updateSchemaTypeClassification(String userId,
                                                 String entityGuid,
                                                 List<Classification> classificationsToUpdate)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 ClassificationException,
                                                 UnrecognizedGUIDException

Updates classifications to an existing schemaType represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the schemaType; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given schemaType guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteSchemaTypeClassification

public SchemaType deleteSchemaTypeClassification(String userId,
                                                 String entityGuid,
                                                 String name)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 ClassificationException,
                                                 UnrecognizedGUIDException

Deletes a given classification from an existing schemaType represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the schemaType; name - name of the classification
Returns:: deleted SchemaType classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getSchemaTypeRelationships
```
public Set<Line> getSchemaTypeRelationships(String userId,
                                            String entityGuid,
                                            String relationshipTypeGuid,
                                            int fromRelationshipElement,
                                            Date asOfTime,
                                            String sequencingProperty,
                                            SequencingOrder sequencingOrder,
                                            int pageSize)
                                     throws MetadataServerUncontactableException,
                                            UserNotAuthorizedException,
                                            InvalidParameterException,
                                            FunctionNotSupportedException,
                                            UnrecognizedGUIDException
```
Get the relationships associated with entity schemaType represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the schemaType

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getDataFileById
```
public DataFile getDataFileById(String userId,
                                String entityGuid)
                         throws MetadataServerUncontactableException,
                                UserNotAuthorizedException,
                                InvalidParameterException,
                                UnrecognizedGUIDException
```
Fetch complete definition of an dataFile given its GUID. The limit and offset paging parameters limit the number elements returned in each of the dataFiles relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

DataFile the DataFile entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createDataFile

public DataFile createDataFile(String userId,
                               DataFile dataFile)
                        throws MetadataServerUncontactableException,
                               UserNotAuthorizedException,
                               InvalidParameterException,
                               ClassificationException,
                               StatusNotSupportedException

Create new dataFile.

Parameters:: userId - user identity; dataFile - the input entity with values.
Returns:: DataFile the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateDataFile
```
public DataFile updateDataFile(String userId,
                               DataFile dataFile)
                        throws MetadataServerUncontactableException,
                               UserNotAuthorizedException,
                               InvalidParameterException,
                               UnrecognizedGUIDException
```
Update dataFile

Parameters:

userId - user identity

dataFile - dataFile to update

Returns:

DataFile the updated dataFile entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteDataFileByGuid
```
public EntityDetail deleteDataFileByGuid(String userId,
                                         String entityGuid)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         FunctionNotSupportedException,
                                         InvalidParameterException,
                                         UnrecognizedGUIDException
```
Delete an dataFile identified by its GUID. Delete is a soft delete, this means that the dataFile has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the dataFile

Returns:

DataFile the deleted DataFile entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeDataFileByGuid
```
public void purgeDataFileByGuid(String userId,
                                String entityGuid)
                         throws MetadataServerUncontactableException,
                                UserNotAuthorizedException,
                                InvalidParameterException,
                                UnrecognizedGUIDException,
                                EntityNotDeletedException,
                                GUIDNotPurgedException
```
Purge an dataFile identified by its GUID. Delete is a hard delete, this means that the dataFile is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the dataFile

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreDataFile
```
public DataFile restoreDataFile(String userId,
                                String entityGuid)
                         throws MetadataServerUncontactableException,
                                UserNotAuthorizedException,
                                InvalidParameterException,
                                UnrecognizedGUIDException,
                                GUIDNotDeletedException,
                                FunctionNotSupportedException
```
Restore an DataFile identified by its GUID. Restore resurrects a soft deleted DataFile. When a DataFile was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the DataFile

Returns:

DataFile the restored DataFile

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the DataFile is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addDataFileClassifications

public DataFile addDataFileClassifications(String userId,
                                           String entityGuid,
                                           List<Classification> classifications)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           InvalidParameterException,
                                           ClassificationException,
                                           UnrecognizedGUIDException

Add classifications to the supplied dataFile

Parameters:: userId - user identity; entityGuid - the GUID value for dataFile; classifications - the classifications to apply.
Returns:: the dataFile entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateDataFileClassification

public DataFile updateDataFileClassification(String userId,
                                             String entityGuid,
                                             List<Classification> classificationsToUpdate)
                                      throws MetadataServerUncontactableException,
                                             UserNotAuthorizedException,
                                             InvalidParameterException,
                                             ClassificationException,
                                             UnrecognizedGUIDException

Updates classifications to an existing dataFile represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the dataFile; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given dataFile guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteDataFileClassification

public DataFile deleteDataFileClassification(String userId,
                                             String entityGuid,
                                             String name)
                                      throws MetadataServerUncontactableException,
                                             UserNotAuthorizedException,
                                             InvalidParameterException,
                                             ClassificationException,
                                             UnrecognizedGUIDException

Deletes a given classification from an existing dataFile represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the dataFile; name - name of the classification
Returns:: deleted DataFile classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getDataFileRelationships
```
public Set<Line> getDataFileRelationships(String userId,
                                          String entityGuid,
                                          String relationshipTypeGuid,
                                          int fromRelationshipElement,
                                          Date asOfTime,
                                          String sequencingProperty,
                                          SequencingOrder sequencingOrder,
                                          int pageSize)
                                   throws MetadataServerUncontactableException,
                                          UserNotAuthorizedException,
                                          InvalidParameterException,
                                          FunctionNotSupportedException,
                                          UnrecognizedGUIDException
```
Get the relationships associated with entity dataFile represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the dataFile

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getLikeById
```
public Like getLikeById(String userId,
                        String entityGuid)
                 throws MetadataServerUncontactableException,
                        UserNotAuthorizedException,
                        InvalidParameterException,
                        UnrecognizedGUIDException
```
Fetch complete definition of an like given its GUID. The limit and offset paging parameters limit the number elements returned in each of the likes relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

Like the Like entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createLike
```
public Like createLike(String userId,
                       Like like)
                throws MetadataServerUncontactableException,
                       UserNotAuthorizedException,
                       InvalidParameterException,
                       ClassificationException,
                       StatusNotSupportedException
```
Create new like.

Parameters:

userId - user identity

like - the input entity with values.

Returns:

Like the created entity.

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

ClassificationException - a classification does not match constraints.

StatusNotSupportedException - status is not supported

updateLike
```
public Like updateLike(String userId,
                       Like like)
                throws MetadataServerUncontactableException,
                       UserNotAuthorizedException,
                       InvalidParameterException,
                       UnrecognizedGUIDException
```
Update like

Parameters:

userId - user identity

like - like to update

Returns:

Like the updated like entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteLikeByGuid
```
public EntityDetail deleteLikeByGuid(String userId,
                                     String entityGuid)
                              throws MetadataServerUncontactableException,
                                     UserNotAuthorizedException,
                                     FunctionNotSupportedException,
                                     InvalidParameterException,
                                     UnrecognizedGUIDException
```
Delete an like identified by its GUID. Delete is a soft delete, this means that the like has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the like

Returns:

Like the deleted Like entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeLikeByGuid
```
public void purgeLikeByGuid(String userId,
                            String entityGuid)
                     throws MetadataServerUncontactableException,
                            UserNotAuthorizedException,
                            InvalidParameterException,
                            UnrecognizedGUIDException,
                            EntityNotDeletedException,
                            GUIDNotPurgedException
```
Purge an like identified by its GUID. Delete is a hard delete, this means that the like is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the like

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreLike
```
public Like restoreLike(String userId,
                        String entityGuid)
                 throws MetadataServerUncontactableException,
                        UserNotAuthorizedException,
                        InvalidParameterException,
                        UnrecognizedGUIDException,
                        GUIDNotDeletedException,
                        FunctionNotSupportedException
```
Restore an Like identified by its GUID. Restore resurrects a soft deleted Like. When a Like was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the Like

Returns:

Like the restored Like

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the Like is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addLikeClassifications

public Like addLikeClassifications(String userId,
                                   String entityGuid,
                                   List<Classification> classifications)
                            throws MetadataServerUncontactableException,
                                   UserNotAuthorizedException,
                                   InvalidParameterException,
                                   ClassificationException,
                                   UnrecognizedGUIDException

Add classifications to the supplied like

Parameters:: userId - user identity; entityGuid - the GUID value for like; classifications - the classifications to apply.
Returns:: the like entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateLikeClassification
```
public Like updateLikeClassification(String userId,
                                     String entityGuid,
                                     List<Classification> classificationsToUpdate)
                              throws MetadataServerUncontactableException,
                                     UserNotAuthorizedException,
                                     InvalidParameterException,
                                     ClassificationException,
                                     UnrecognizedGUIDException
```
Updates classifications to an existing like represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the like

classificationsToUpdate - List of classifications to update entity with

Returns:

classification for the given like guid

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

ClassificationException - a classification does not match constraints.

deleteLikeClassification
```
public Like deleteLikeClassification(String userId,
                                     String entityGuid,
                                     String name)
                              throws MetadataServerUncontactableException,
                                     UserNotAuthorizedException,
                                     InvalidParameterException,
                                     ClassificationException,
                                     UnrecognizedGUIDException
```
Deletes a given classification from an existing like represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the like

name - name of the classification

Returns:

deleted Like classification

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

ClassificationException - a classification does not match constraints.

getLikeRelationships
```
public Set<Line> getLikeRelationships(String userId,
                                      String entityGuid,
                                      String relationshipTypeGuid,
                                      int fromRelationshipElement,
                                      Date asOfTime,
                                      String sequencingProperty,
                                      SequencingOrder sequencingOrder,
                                      int pageSize)
                               throws MetadataServerUncontactableException,
                                      UserNotAuthorizedException,
                                      InvalidParameterException,
                                      FunctionNotSupportedException,
                                      UnrecognizedGUIDException
```
Get the relationships associated with entity like represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the like

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getReferenceableById
```
public Referenceable getReferenceableById(String userId,
                                          String entityGuid)
                                   throws MetadataServerUncontactableException,
                                          UserNotAuthorizedException,
                                          InvalidParameterException,
                                          UnrecognizedGUIDException
```
Fetch complete definition of an referenceable given its GUID. The limit and offset paging parameters limit the number elements returned in each of the referenceables relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

Referenceable the Referenceable entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createReferenceable

public Referenceable createReferenceable(String userId,
                                         Referenceable referenceable)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         InvalidParameterException,
                                         ClassificationException,
                                         StatusNotSupportedException

Create new referenceable.

Parameters:: userId - user identity; referenceable - the input entity with values.
Returns:: Referenceable the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateReferenceable
```
public Referenceable updateReferenceable(String userId,
                                         Referenceable referenceable)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         InvalidParameterException,
                                         UnrecognizedGUIDException
```
Update referenceable

Parameters:

userId - user identity

referenceable - referenceable to update

Returns:

Referenceable the updated referenceable entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteReferenceableByGuid
```
public EntityDetail deleteReferenceableByGuid(String userId,
                                              String entityGuid)
                                       throws MetadataServerUncontactableException,
                                              UserNotAuthorizedException,
                                              FunctionNotSupportedException,
                                              InvalidParameterException,
                                              UnrecognizedGUIDException
```
Delete an referenceable identified by its GUID. Delete is a soft delete, this means that the referenceable has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the referenceable

Returns:

Referenceable the deleted Referenceable entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeReferenceableByGuid
```
public void purgeReferenceableByGuid(String userId,
                                     String entityGuid)
                              throws MetadataServerUncontactableException,
                                     UserNotAuthorizedException,
                                     InvalidParameterException,
                                     UnrecognizedGUIDException,
                                     EntityNotDeletedException,
                                     GUIDNotPurgedException
```
Purge an referenceable identified by its GUID. Delete is a hard delete, this means that the referenceable is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the referenceable

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreReferenceable
```
public Referenceable restoreReferenceable(String userId,
                                          String entityGuid)
                                   throws MetadataServerUncontactableException,
                                          UserNotAuthorizedException,
                                          InvalidParameterException,
                                          UnrecognizedGUIDException,
                                          GUIDNotDeletedException,
                                          FunctionNotSupportedException
```
Restore an Referenceable identified by its GUID. Restore resurrects a soft deleted Referenceable. When a Referenceable was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the Referenceable

Returns:

Referenceable the restored Referenceable

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the Referenceable is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addReferenceableClassifications

public Referenceable addReferenceableClassifications(String userId,
                                                     String entityGuid,
                                                     List<Classification> classifications)
                                              throws MetadataServerUncontactableException,
                                                     UserNotAuthorizedException,
                                                     InvalidParameterException,
                                                     ClassificationException,
                                                     UnrecognizedGUIDException

Add classifications to the supplied referenceable

Parameters:: userId - user identity; entityGuid - the GUID value for referenceable; classifications - the classifications to apply.
Returns:: the referenceable entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateReferenceableClassification

public Referenceable updateReferenceableClassification(String userId,
                                                       String entityGuid,
                                                       List<Classification> classificationsToUpdate)
                                                throws MetadataServerUncontactableException,
                                                       UserNotAuthorizedException,
                                                       InvalidParameterException,
                                                       ClassificationException,
                                                       UnrecognizedGUIDException

Updates classifications to an existing referenceable represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the referenceable; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given referenceable guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteReferenceableClassification

public Referenceable deleteReferenceableClassification(String userId,
                                                       String entityGuid,
                                                       String name)
                                                throws MetadataServerUncontactableException,
                                                       UserNotAuthorizedException,
                                                       InvalidParameterException,
                                                       ClassificationException,
                                                       UnrecognizedGUIDException

Deletes a given classification from an existing referenceable represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the referenceable; name - name of the classification
Returns:: deleted Referenceable classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getReferenceableRelationships
```
public Set<Line> getReferenceableRelationships(String userId,
                                               String entityGuid,
                                               String relationshipTypeGuid,
                                               int fromRelationshipElement,
                                               Date asOfTime,
                                               String sequencingProperty,
                                               SequencingOrder sequencingOrder,
                                               int pageSize)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               InvalidParameterException,
                                               FunctionNotSupportedException,
                                               UnrecognizedGUIDException
```
Get the relationships associated with entity referenceable represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the referenceable

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getExternalReferenceById
```
public ExternalReference getExternalReferenceById(String userId,
                                                  String entityGuid)
                                           throws MetadataServerUncontactableException,
                                                  UserNotAuthorizedException,
                                                  InvalidParameterException,
                                                  UnrecognizedGUIDException
```
Fetch complete definition of an externalReference given its GUID. The limit and offset paging parameters limit the number elements returned in each of the externalReferences relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

ExternalReference the ExternalReference entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createExternalReference

public ExternalReference createExternalReference(String userId,
                                                 ExternalReference externalReference)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 ClassificationException,
                                                 StatusNotSupportedException

Create new externalReference.

Parameters:: userId - user identity; externalReference - the input entity with values.
Returns:: ExternalReference the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateExternalReference

public ExternalReference updateExternalReference(String userId,
                                                 ExternalReference externalReference)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 UnrecognizedGUIDException

Update externalReference

Parameters:: userId - user identity; externalReference - externalReference to update
Returns:: ExternalReference the updated externalReference entity
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteExternalReferenceByGuid
```
public EntityDetail deleteExternalReferenceByGuid(String userId,
                                                  String entityGuid)
                                           throws MetadataServerUncontactableException,
                                                  UserNotAuthorizedException,
                                                  FunctionNotSupportedException,
                                                  InvalidParameterException,
                                                  UnrecognizedGUIDException
```
Delete an externalReference identified by its GUID. Delete is a soft delete, this means that the externalReference has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the externalReference

Returns:

ExternalReference the deleted ExternalReference entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeExternalReferenceByGuid
```
public void purgeExternalReferenceByGuid(String userId,
                                         String entityGuid)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         InvalidParameterException,
                                         UnrecognizedGUIDException,
                                         EntityNotDeletedException,
                                         GUIDNotPurgedException
```
Purge an externalReference identified by its GUID. Delete is a hard delete, this means that the externalReference is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the externalReference

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreExternalReference
```
public ExternalReference restoreExternalReference(String userId,
                                                  String entityGuid)
                                           throws MetadataServerUncontactableException,
                                                  UserNotAuthorizedException,
                                                  InvalidParameterException,
                                                  UnrecognizedGUIDException,
                                                  GUIDNotDeletedException,
                                                  FunctionNotSupportedException
```
Restore an ExternalReference identified by its GUID. Restore resurrects a soft deleted ExternalReference. When a ExternalReference was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the ExternalReference

Returns:

ExternalReference the restored ExternalReference

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the ExternalReference is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addExternalReferenceClassifications

public ExternalReference addExternalReferenceClassifications(String userId,
                                                             String entityGuid,
                                                             List<Classification> classifications)
                                                      throws MetadataServerUncontactableException,
                                                             UserNotAuthorizedException,
                                                             InvalidParameterException,
                                                             ClassificationException,
                                                             UnrecognizedGUIDException

Add classifications to the supplied externalReference

Parameters:: userId - user identity; entityGuid - the GUID value for externalReference; classifications - the classifications to apply.
Returns:: the externalReference entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateExternalReferenceClassification

public ExternalReference updateExternalReferenceClassification(String userId,
                                                               String entityGuid,
                                                               List<Classification> classificationsToUpdate)
                                                        throws MetadataServerUncontactableException,
                                                               UserNotAuthorizedException,
                                                               InvalidParameterException,
                                                               ClassificationException,
                                                               UnrecognizedGUIDException

Updates classifications to an existing externalReference represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the externalReference; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given externalReference guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteExternalReferenceClassification

public ExternalReference deleteExternalReferenceClassification(String userId,
                                                               String entityGuid,
                                                               String name)
                                                        throws MetadataServerUncontactableException,
                                                               UserNotAuthorizedException,
                                                               InvalidParameterException,
                                                               ClassificationException,
                                                               UnrecognizedGUIDException

Deletes a given classification from an existing externalReference represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the externalReference; name - name of the classification
Returns:: deleted ExternalReference classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getExternalReferenceRelationships
```
public Set<Line> getExternalReferenceRelationships(String userId,
                                                   String entityGuid,
                                                   String relationshipTypeGuid,
                                                   int fromRelationshipElement,
                                                   Date asOfTime,
                                                   String sequencingProperty,
                                                   SequencingOrder sequencingOrder,
                                                   int pageSize)
                                            throws MetadataServerUncontactableException,
                                                   UserNotAuthorizedException,
                                                   InvalidParameterException,
                                                   FunctionNotSupportedException,
                                                   UnrecognizedGUIDException
```
Get the relationships associated with entity externalReference represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the externalReference

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getEndpointById
```
public Endpoint getEndpointById(String userId,
                                String entityGuid)
                         throws MetadataServerUncontactableException,
                                UserNotAuthorizedException,
                                InvalidParameterException,
                                UnrecognizedGUIDException
```
Fetch complete definition of an endpoint given its GUID. The limit and offset paging parameters limit the number elements returned in each of the endpoints relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

Endpoint the Endpoint entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createEndpoint

public Endpoint createEndpoint(String userId,
                               Endpoint endpoint)
                        throws MetadataServerUncontactableException,
                               UserNotAuthorizedException,
                               InvalidParameterException,
                               ClassificationException,
                               StatusNotSupportedException

Create new endpoint.

Parameters:: userId - user identity; endpoint - the input entity with values.
Returns:: Endpoint the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateEndpoint
```
public Endpoint updateEndpoint(String userId,
                               Endpoint endpoint)
                        throws MetadataServerUncontactableException,
                               UserNotAuthorizedException,
                               InvalidParameterException,
                               UnrecognizedGUIDException
```
Update endpoint

Parameters:

userId - user identity

endpoint - endpoint to update

Returns:

Endpoint the updated endpoint entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteEndpointByGuid
```
public EntityDetail deleteEndpointByGuid(String userId,
                                         String entityGuid)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         FunctionNotSupportedException,
                                         InvalidParameterException,
                                         UnrecognizedGUIDException
```
Delete an endpoint identified by its GUID. Delete is a soft delete, this means that the endpoint has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the endpoint

Returns:

Endpoint the deleted Endpoint entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeEndpointByGuid
```
public void purgeEndpointByGuid(String userId,
                                String entityGuid)
                         throws MetadataServerUncontactableException,
                                UserNotAuthorizedException,
                                InvalidParameterException,
                                UnrecognizedGUIDException,
                                EntityNotDeletedException,
                                GUIDNotPurgedException
```
Purge an endpoint identified by its GUID. Delete is a hard delete, this means that the endpoint is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the endpoint

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreEndpoint
```
public Endpoint restoreEndpoint(String userId,
                                String entityGuid)
                         throws MetadataServerUncontactableException,
                                UserNotAuthorizedException,
                                InvalidParameterException,
                                UnrecognizedGUIDException,
                                GUIDNotDeletedException,
                                FunctionNotSupportedException
```
Restore an Endpoint identified by its GUID. Restore resurrects a soft deleted Endpoint. When a Endpoint was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the Endpoint

Returns:

Endpoint the restored Endpoint

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the Endpoint is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addEndpointClassifications

public Endpoint addEndpointClassifications(String userId,
                                           String entityGuid,
                                           List<Classification> classifications)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           InvalidParameterException,
                                           ClassificationException,
                                           UnrecognizedGUIDException

Add classifications to the supplied endpoint

Parameters:: userId - user identity; entityGuid - the GUID value for endpoint; classifications - the classifications to apply.
Returns:: the endpoint entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateEndpointClassification

public Endpoint updateEndpointClassification(String userId,
                                             String entityGuid,
                                             List<Classification> classificationsToUpdate)
                                      throws MetadataServerUncontactableException,
                                             UserNotAuthorizedException,
                                             InvalidParameterException,
                                             ClassificationException,
                                             UnrecognizedGUIDException

Updates classifications to an existing endpoint represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the endpoint; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given endpoint guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteEndpointClassification

public Endpoint deleteEndpointClassification(String userId,
                                             String entityGuid,
                                             String name)
                                      throws MetadataServerUncontactableException,
                                             UserNotAuthorizedException,
                                             InvalidParameterException,
                                             ClassificationException,
                                             UnrecognizedGUIDException

Deletes a given classification from an existing endpoint represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the endpoint; name - name of the classification
Returns:: deleted Endpoint classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getEndpointRelationships
```
public Set<Line> getEndpointRelationships(String userId,
                                          String entityGuid,
                                          String relationshipTypeGuid,
                                          int fromRelationshipElement,
                                          Date asOfTime,
                                          String sequencingProperty,
                                          SequencingOrder sequencingOrder,
                                          int pageSize)
                                   throws MetadataServerUncontactableException,
                                          UserNotAuthorizedException,
                                          InvalidParameterException,
                                          FunctionNotSupportedException,
                                          UnrecognizedGUIDException
```
Get the relationships associated with entity endpoint represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the endpoint

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getContactDetailsById
```
public ContactDetails getContactDetailsById(String userId,
                                            String entityGuid)
                                     throws MetadataServerUncontactableException,
                                            UserNotAuthorizedException,
                                            InvalidParameterException,
                                            UnrecognizedGUIDException
```
Fetch complete definition of an contactDetails given its GUID. The limit and offset paging parameters limit the number elements returned in each of the contactDetailses relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

ContactDetails the ContactDetails entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createContactDetails

public ContactDetails createContactDetails(String userId,
                                           ContactDetails contactDetails)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           InvalidParameterException,
                                           ClassificationException,
                                           StatusNotSupportedException

Create new contactDetails.

Parameters:: userId - user identity; contactDetails - the input entity with values.
Returns:: ContactDetails the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateContactDetails

public ContactDetails updateContactDetails(String userId,
                                           ContactDetails contactDetails)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           InvalidParameterException,
                                           UnrecognizedGUIDException

Update contactDetails

Parameters:: userId - user identity; contactDetails - contactDetails to update
Returns:: ContactDetails the updated contactDetails entity
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteContactDetailsByGuid
```
public EntityDetail deleteContactDetailsByGuid(String userId,
                                               String entityGuid)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               FunctionNotSupportedException,
                                               InvalidParameterException,
                                               UnrecognizedGUIDException
```
Delete an contactDetails identified by its GUID. Delete is a soft delete, this means that the contactDetails has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the contactDetails

Returns:

ContactDetails the deleted ContactDetails entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeContactDetailsByGuid
```
public void purgeContactDetailsByGuid(String userId,
                                      String entityGuid)
                               throws MetadataServerUncontactableException,
                                      UserNotAuthorizedException,
                                      InvalidParameterException,
                                      UnrecognizedGUIDException,
                                      EntityNotDeletedException,
                                      GUIDNotPurgedException
```
Purge an contactDetails identified by its GUID. Delete is a hard delete, this means that the contactDetails is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the contactDetails

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreContactDetails
```
public ContactDetails restoreContactDetails(String userId,
                                            String entityGuid)
                                     throws MetadataServerUncontactableException,
                                            UserNotAuthorizedException,
                                            InvalidParameterException,
                                            UnrecognizedGUIDException,
                                            GUIDNotDeletedException,
                                            FunctionNotSupportedException
```
Restore an ContactDetails identified by its GUID. Restore resurrects a soft deleted ContactDetails. When a ContactDetails was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the ContactDetails

Returns:

ContactDetails the restored ContactDetails

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the ContactDetails is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addContactDetailsClassifications

public ContactDetails addContactDetailsClassifications(String userId,
                                                       String entityGuid,
                                                       List<Classification> classifications)
                                                throws MetadataServerUncontactableException,
                                                       UserNotAuthorizedException,
                                                       InvalidParameterException,
                                                       ClassificationException,
                                                       UnrecognizedGUIDException

Add classifications to the supplied contactDetails

Parameters:: userId - user identity; entityGuid - the GUID value for contactDetails; classifications - the classifications to apply.
Returns:: the contactDetails entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateContactDetailsClassification

public ContactDetails updateContactDetailsClassification(String userId,
                                                         String entityGuid,
                                                         List<Classification> classificationsToUpdate)
                                                  throws MetadataServerUncontactableException,
                                                         UserNotAuthorizedException,
                                                         InvalidParameterException,
                                                         ClassificationException,
                                                         UnrecognizedGUIDException

Updates classifications to an existing contactDetails represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the contactDetails; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given contactDetails guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteContactDetailsClassification

public ContactDetails deleteContactDetailsClassification(String userId,
                                                         String entityGuid,
                                                         String name)
                                                  throws MetadataServerUncontactableException,
                                                         UserNotAuthorizedException,
                                                         InvalidParameterException,
                                                         ClassificationException,
                                                         UnrecognizedGUIDException

Deletes a given classification from an existing contactDetails represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the contactDetails; name - name of the classification
Returns:: deleted ContactDetails classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getContactDetailsRelationships
```
public Set<Line> getContactDetailsRelationships(String userId,
                                                String entityGuid,
                                                String relationshipTypeGuid,
                                                int fromRelationshipElement,
                                                Date asOfTime,
                                                String sequencingProperty,
                                                SequencingOrder sequencingOrder,
                                                int pageSize)
                                         throws MetadataServerUncontactableException,
                                                UserNotAuthorizedException,
                                                InvalidParameterException,
                                                FunctionNotSupportedException,
                                                UnrecognizedGUIDException
```
Get the relationships associated with entity contactDetails represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the contactDetails

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getGovernanceDefinitionById
```
public GovernanceDefinition getGovernanceDefinitionById(String userId,
                                                        String entityGuid)
                                                 throws MetadataServerUncontactableException,
                                                        UserNotAuthorizedException,
                                                        InvalidParameterException,
                                                        UnrecognizedGUIDException
```
Fetch complete definition of an governanceDefinition given its GUID. The limit and offset paging parameters limit the number elements returned in each of the governanceDefinitions relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

GovernanceDefinition the GovernanceDefinition entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createGovernanceDefinition

public GovernanceDefinition createGovernanceDefinition(String userId,
                                                       GovernanceDefinition governanceDefinition)
                                                throws MetadataServerUncontactableException,
                                                       UserNotAuthorizedException,
                                                       InvalidParameterException,
                                                       ClassificationException,
                                                       StatusNotSupportedException

Create new governanceDefinition.

Parameters:: userId - user identity; governanceDefinition - the input entity with values.
Returns:: GovernanceDefinition the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateGovernanceDefinition

public GovernanceDefinition updateGovernanceDefinition(String userId,
                                                       GovernanceDefinition governanceDefinition)
                                                throws MetadataServerUncontactableException,
                                                       UserNotAuthorizedException,
                                                       InvalidParameterException,
                                                       UnrecognizedGUIDException

Update governanceDefinition

Parameters:: userId - user identity; governanceDefinition - governanceDefinition to update
Returns:: GovernanceDefinition the updated governanceDefinition entity
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteGovernanceDefinitionByGuid
```
public EntityDetail deleteGovernanceDefinitionByGuid(String userId,
                                                     String entityGuid)
                                              throws MetadataServerUncontactableException,
                                                     UserNotAuthorizedException,
                                                     FunctionNotSupportedException,
                                                     InvalidParameterException,
                                                     UnrecognizedGUIDException
```
Delete an governanceDefinition identified by its GUID. Delete is a soft delete, this means that the governanceDefinition has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the governanceDefinition

Returns:

GovernanceDefinition the deleted GovernanceDefinition entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeGovernanceDefinitionByGuid
```
public void purgeGovernanceDefinitionByGuid(String userId,
                                            String entityGuid)
                                     throws MetadataServerUncontactableException,
                                            UserNotAuthorizedException,
                                            InvalidParameterException,
                                            UnrecognizedGUIDException,
                                            EntityNotDeletedException,
                                            GUIDNotPurgedException
```
Purge an governanceDefinition identified by its GUID. Delete is a hard delete, this means that the governanceDefinition is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the governanceDefinition

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreGovernanceDefinition

public GovernanceDefinition restoreGovernanceDefinition(String userId,
                                                        String entityGuid)
                                                 throws MetadataServerUncontactableException,
                                                        UserNotAuthorizedException,
                                                        InvalidParameterException,
                                                        UnrecognizedGUIDException,
                                                        GUIDNotDeletedException,
                                                        FunctionNotSupportedException

Restore an GovernanceDefinition identified by its GUID. Restore resurrects a soft deleted GovernanceDefinition. When a GovernanceDefinition was incorrectly deleted, the delete can be undone using the restore..

Parameters:: userId - user identity; entityGuid - GUID for the GovernanceDefinition
Returns:: GovernanceDefinition the restored GovernanceDefinition
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; GUIDNotDeletedException - the guid of the GovernanceDefinition is not deleted, so cannot be restored; FunctionNotSupportedException - Function not supported

addGovernanceDefinitionClassifications

public GovernanceDefinition addGovernanceDefinitionClassifications(String userId,
                                                                   String entityGuid,
                                                                   List<Classification> classifications)
                                                            throws MetadataServerUncontactableException,
                                                                   UserNotAuthorizedException,
                                                                   InvalidParameterException,
                                                                   ClassificationException,
                                                                   UnrecognizedGUIDException

Add classifications to the supplied governanceDefinition

Parameters:: userId - user identity; entityGuid - the GUID value for governanceDefinition; classifications - the classifications to apply.
Returns:: the governanceDefinition entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateGovernanceDefinitionClassification

public GovernanceDefinition updateGovernanceDefinitionClassification(String userId,
                                                                     String entityGuid,
                                                                     List<Classification> classificationsToUpdate)
                                                              throws MetadataServerUncontactableException,
                                                                     UserNotAuthorizedException,
                                                                     InvalidParameterException,
                                                                     ClassificationException,
                                                                     UnrecognizedGUIDException

Updates classifications to an existing governanceDefinition represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the governanceDefinition; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given governanceDefinition guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteGovernanceDefinitionClassification

public GovernanceDefinition deleteGovernanceDefinitionClassification(String userId,
                                                                     String entityGuid,
                                                                     String name)
                                                              throws MetadataServerUncontactableException,
                                                                     UserNotAuthorizedException,
                                                                     InvalidParameterException,
                                                                     ClassificationException,
                                                                     UnrecognizedGUIDException

Deletes a given classification from an existing governanceDefinition represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the governanceDefinition; name - name of the classification
Returns:: deleted GovernanceDefinition classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getGovernanceDefinitionRelationships
```
public Set<Line> getGovernanceDefinitionRelationships(String userId,
                                                      String entityGuid,
                                                      String relationshipTypeGuid,
                                                      int fromRelationshipElement,
                                                      Date asOfTime,
                                                      String sequencingProperty,
                                                      SequencingOrder sequencingOrder,
                                                      int pageSize)
                                               throws MetadataServerUncontactableException,
                                                      UserNotAuthorizedException,
                                                      InvalidParameterException,
                                                      FunctionNotSupportedException,
                                                      UnrecognizedGUIDException
```
Get the relationships associated with entity governanceDefinition represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the governanceDefinition

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getFileFolderById
```
public FileFolder getFileFolderById(String userId,
                                    String entityGuid)
                             throws MetadataServerUncontactableException,
                                    UserNotAuthorizedException,
                                    InvalidParameterException,
                                    UnrecognizedGUIDException
```
Fetch complete definition of an fileFolder given its GUID. The limit and offset paging parameters limit the number elements returned in each of the fileFolders relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

FileFolder the FileFolder entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createFileFolder

public FileFolder createFileFolder(String userId,
                                   FileFolder fileFolder)
                            throws MetadataServerUncontactableException,
                                   UserNotAuthorizedException,
                                   InvalidParameterException,
                                   ClassificationException,
                                   StatusNotSupportedException

Create new fileFolder.

Parameters:: userId - user identity; fileFolder - the input entity with values.
Returns:: FileFolder the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateFileFolder
```
public FileFolder updateFileFolder(String userId,
                                   FileFolder fileFolder)
                            throws MetadataServerUncontactableException,
                                   UserNotAuthorizedException,
                                   InvalidParameterException,
                                   UnrecognizedGUIDException
```
Update fileFolder

Parameters:

userId - user identity

fileFolder - fileFolder to update

Returns:

FileFolder the updated fileFolder entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteFileFolderByGuid
```
public EntityDetail deleteFileFolderByGuid(String userId,
                                           String entityGuid)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           FunctionNotSupportedException,
                                           InvalidParameterException,
                                           UnrecognizedGUIDException
```
Delete an fileFolder identified by its GUID. Delete is a soft delete, this means that the fileFolder has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the fileFolder

Returns:

FileFolder the deleted FileFolder entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeFileFolderByGuid
```
public void purgeFileFolderByGuid(String userId,
                                  String entityGuid)
                           throws MetadataServerUncontactableException,
                                  UserNotAuthorizedException,
                                  InvalidParameterException,
                                  UnrecognizedGUIDException,
                                  EntityNotDeletedException,
                                  GUIDNotPurgedException
```
Purge an fileFolder identified by its GUID. Delete is a hard delete, this means that the fileFolder is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the fileFolder

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreFileFolder
```
public FileFolder restoreFileFolder(String userId,
                                    String entityGuid)
                             throws MetadataServerUncontactableException,
                                    UserNotAuthorizedException,
                                    InvalidParameterException,
                                    UnrecognizedGUIDException,
                                    GUIDNotDeletedException,
                                    FunctionNotSupportedException
```
Restore an FileFolder identified by its GUID. Restore resurrects a soft deleted FileFolder. When a FileFolder was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the FileFolder

Returns:

FileFolder the restored FileFolder

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the FileFolder is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addFileFolderClassifications

public FileFolder addFileFolderClassifications(String userId,
                                               String entityGuid,
                                               List<Classification> classifications)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               InvalidParameterException,
                                               ClassificationException,
                                               UnrecognizedGUIDException

Add classifications to the supplied fileFolder

Parameters:: userId - user identity; entityGuid - the GUID value for fileFolder; classifications - the classifications to apply.
Returns:: the fileFolder entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateFileFolderClassification

public FileFolder updateFileFolderClassification(String userId,
                                                 String entityGuid,
                                                 List<Classification> classificationsToUpdate)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 ClassificationException,
                                                 UnrecognizedGUIDException

Updates classifications to an existing fileFolder represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the fileFolder; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given fileFolder guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteFileFolderClassification

public FileFolder deleteFileFolderClassification(String userId,
                                                 String entityGuid,
                                                 String name)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 ClassificationException,
                                                 UnrecognizedGUIDException

Deletes a given classification from an existing fileFolder represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the fileFolder; name - name of the classification
Returns:: deleted FileFolder classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getFileFolderRelationships
```
public Set<Line> getFileFolderRelationships(String userId,
                                            String entityGuid,
                                            String relationshipTypeGuid,
                                            int fromRelationshipElement,
                                            Date asOfTime,
                                            String sequencingProperty,
                                            SequencingOrder sequencingOrder,
                                            int pageSize)
                                     throws MetadataServerUncontactableException,
                                            UserNotAuthorizedException,
                                            InvalidParameterException,
                                            FunctionNotSupportedException,
                                            UnrecognizedGUIDException
```
Get the relationships associated with entity fileFolder represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the fileFolder

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getNetworkById
```
public Network getNetworkById(String userId,
                              String entityGuid)
                       throws MetadataServerUncontactableException,
                              UserNotAuthorizedException,
                              InvalidParameterException,
                              UnrecognizedGUIDException
```
Fetch complete definition of an network given its GUID. The limit and offset paging parameters limit the number elements returned in each of the networks relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

Network the Network entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createNetwork

public Network createNetwork(String userId,
                             Network network)
                      throws MetadataServerUncontactableException,
                             UserNotAuthorizedException,
                             InvalidParameterException,
                             ClassificationException,
                             StatusNotSupportedException

Create new network.

Parameters:: userId - user identity; network - the input entity with values.
Returns:: Network the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateNetwork
```
public Network updateNetwork(String userId,
                             Network network)
                      throws MetadataServerUncontactableException,
                             UserNotAuthorizedException,
                             InvalidParameterException,
                             UnrecognizedGUIDException
```
Update network

Parameters:

userId - user identity

network - network to update

Returns:

Network the updated network entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteNetworkByGuid
```
public EntityDetail deleteNetworkByGuid(String userId,
                                        String entityGuid)
                                 throws MetadataServerUncontactableException,
                                        UserNotAuthorizedException,
                                        FunctionNotSupportedException,
                                        InvalidParameterException,
                                        UnrecognizedGUIDException
```
Delete an network identified by its GUID. Delete is a soft delete, this means that the network has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the network

Returns:

Network the deleted Network entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeNetworkByGuid
```
public void purgeNetworkByGuid(String userId,
                               String entityGuid)
                        throws MetadataServerUncontactableException,
                               UserNotAuthorizedException,
                               InvalidParameterException,
                               UnrecognizedGUIDException,
                               EntityNotDeletedException,
                               GUIDNotPurgedException
```
Purge an network identified by its GUID. Delete is a hard delete, this means that the network is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the network

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreNetwork
```
public Network restoreNetwork(String userId,
                              String entityGuid)
                       throws MetadataServerUncontactableException,
                              UserNotAuthorizedException,
                              InvalidParameterException,
                              UnrecognizedGUIDException,
                              GUIDNotDeletedException,
                              FunctionNotSupportedException
```
Restore an Network identified by its GUID. Restore resurrects a soft deleted Network. When a Network was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the Network

Returns:

Network the restored Network

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the Network is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addNetworkClassifications

public Network addNetworkClassifications(String userId,
                                         String entityGuid,
                                         List<Classification> classifications)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         InvalidParameterException,
                                         ClassificationException,
                                         UnrecognizedGUIDException

Add classifications to the supplied network

Parameters:: userId - user identity; entityGuid - the GUID value for network; classifications - the classifications to apply.
Returns:: the network entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateNetworkClassification

public Network updateNetworkClassification(String userId,
                                           String entityGuid,
                                           List<Classification> classificationsToUpdate)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           InvalidParameterException,
                                           ClassificationException,
                                           UnrecognizedGUIDException

Updates classifications to an existing network represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the network; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given network guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteNetworkClassification

public Network deleteNetworkClassification(String userId,
                                           String entityGuid,
                                           String name)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           InvalidParameterException,
                                           ClassificationException,
                                           UnrecognizedGUIDException

Deletes a given classification from an existing network represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the network; name - name of the classification
Returns:: deleted Network classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getNetworkRelationships
```
public Set<Line> getNetworkRelationships(String userId,
                                         String entityGuid,
                                         String relationshipTypeGuid,
                                         int fromRelationshipElement,
                                         Date asOfTime,
                                         String sequencingProperty,
                                         SequencingOrder sequencingOrder,
                                         int pageSize)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         InvalidParameterException,
                                         FunctionNotSupportedException,
                                         UnrecognizedGUIDException
```
Get the relationships associated with entity network represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the network

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getActorProfileById
```
public ActorProfile getActorProfileById(String userId,
                                        String entityGuid)
                                 throws MetadataServerUncontactableException,
                                        UserNotAuthorizedException,
                                        InvalidParameterException,
                                        UnrecognizedGUIDException
```
Fetch complete definition of an actorProfile given its GUID. The limit and offset paging parameters limit the number elements returned in each of the actorProfiles relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

ActorProfile the ActorProfile entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createActorProfile

public ActorProfile createActorProfile(String userId,
                                       ActorProfile actorProfile)
                                throws MetadataServerUncontactableException,
                                       UserNotAuthorizedException,
                                       InvalidParameterException,
                                       ClassificationException,
                                       StatusNotSupportedException

Create new actorProfile.

Parameters:: userId - user identity; actorProfile - the input entity with values.
Returns:: ActorProfile the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateActorProfile
```
public ActorProfile updateActorProfile(String userId,
                                       ActorProfile actorProfile)
                                throws MetadataServerUncontactableException,
                                       UserNotAuthorizedException,
                                       InvalidParameterException,
                                       UnrecognizedGUIDException
```
Update actorProfile

Parameters:

userId - user identity

actorProfile - actorProfile to update

Returns:

ActorProfile the updated actorProfile entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteActorProfileByGuid
```
public EntityDetail deleteActorProfileByGuid(String userId,
                                             String entityGuid)
                                      throws MetadataServerUncontactableException,
                                             UserNotAuthorizedException,
                                             FunctionNotSupportedException,
                                             InvalidParameterException,
                                             UnrecognizedGUIDException
```
Delete an actorProfile identified by its GUID. Delete is a soft delete, this means that the actorProfile has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the actorProfile

Returns:

ActorProfile the deleted ActorProfile entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeActorProfileByGuid
```
public void purgeActorProfileByGuid(String userId,
                                    String entityGuid)
                             throws MetadataServerUncontactableException,
                                    UserNotAuthorizedException,
                                    InvalidParameterException,
                                    UnrecognizedGUIDException,
                                    EntityNotDeletedException,
                                    GUIDNotPurgedException
```
Purge an actorProfile identified by its GUID. Delete is a hard delete, this means that the actorProfile is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the actorProfile

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreActorProfile
```
public ActorProfile restoreActorProfile(String userId,
                                        String entityGuid)
                                 throws MetadataServerUncontactableException,
                                        UserNotAuthorizedException,
                                        InvalidParameterException,
                                        UnrecognizedGUIDException,
                                        GUIDNotDeletedException,
                                        FunctionNotSupportedException
```
Restore an ActorProfile identified by its GUID. Restore resurrects a soft deleted ActorProfile. When a ActorProfile was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the ActorProfile

Returns:

ActorProfile the restored ActorProfile

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the ActorProfile is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addActorProfileClassifications

public ActorProfile addActorProfileClassifications(String userId,
                                                   String entityGuid,
                                                   List<Classification> classifications)
                                            throws MetadataServerUncontactableException,
                                                   UserNotAuthorizedException,
                                                   InvalidParameterException,
                                                   ClassificationException,
                                                   UnrecognizedGUIDException

Add classifications to the supplied actorProfile

Parameters:: userId - user identity; entityGuid - the GUID value for actorProfile; classifications - the classifications to apply.
Returns:: the actorProfile entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateActorProfileClassification

public ActorProfile updateActorProfileClassification(String userId,
                                                     String entityGuid,
                                                     List<Classification> classificationsToUpdate)
                                              throws MetadataServerUncontactableException,
                                                     UserNotAuthorizedException,
                                                     InvalidParameterException,
                                                     ClassificationException,
                                                     UnrecognizedGUIDException

Updates classifications to an existing actorProfile represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the actorProfile; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given actorProfile guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteActorProfileClassification

public ActorProfile deleteActorProfileClassification(String userId,
                                                     String entityGuid,
                                                     String name)
                                              throws MetadataServerUncontactableException,
                                                     UserNotAuthorizedException,
                                                     InvalidParameterException,
                                                     ClassificationException,
                                                     UnrecognizedGUIDException

Deletes a given classification from an existing actorProfile represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the actorProfile; name - name of the classification
Returns:: deleted ActorProfile classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getActorProfileRelationships
```
public Set<Line> getActorProfileRelationships(String userId,
                                              String entityGuid,
                                              String relationshipTypeGuid,
                                              int fromRelationshipElement,
                                              Date asOfTime,
                                              String sequencingProperty,
                                              SequencingOrder sequencingOrder,
                                              int pageSize)
                                       throws MetadataServerUncontactableException,
                                              UserNotAuthorizedException,
                                              InvalidParameterException,
                                              FunctionNotSupportedException,
                                              UnrecognizedGUIDException
```
Get the relationships associated with entity actorProfile represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the actorProfile

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getAssetById
```
public Asset getAssetById(String userId,
                          String entityGuid)
                   throws MetadataServerUncontactableException,
                          UserNotAuthorizedException,
                          InvalidParameterException,
                          UnrecognizedGUIDException
```
Fetch complete definition of an asset given its GUID. The limit and offset paging parameters limit the number elements returned in each of the assets relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

Asset the Asset entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createAsset
```
public Asset createAsset(String userId,
                         Asset asset)
                  throws MetadataServerUncontactableException,
                         UserNotAuthorizedException,
                         InvalidParameterException,
                         ClassificationException,
                         StatusNotSupportedException
```
Create new asset.

Parameters:

userId - user identity

asset - the input entity with values.

Returns:

Asset the created entity.

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

ClassificationException - a classification does not match constraints.

StatusNotSupportedException - status is not supported

updateAsset
```
public Asset updateAsset(String userId,
                         Asset asset)
                  throws MetadataServerUncontactableException,
                         UserNotAuthorizedException,
                         InvalidParameterException,
                         UnrecognizedGUIDException
```
Update asset

Parameters:

userId - user identity

asset - asset to update

Returns:

Asset the updated asset entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteAssetByGuid
```
public EntityDetail deleteAssetByGuid(String userId,
                                      String entityGuid)
                               throws MetadataServerUncontactableException,
                                      UserNotAuthorizedException,
                                      FunctionNotSupportedException,
                                      InvalidParameterException,
                                      UnrecognizedGUIDException
```
Delete an asset identified by its GUID. Delete is a soft delete, this means that the asset has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the asset

Returns:

Asset the deleted Asset entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeAssetByGuid
```
public void purgeAssetByGuid(String userId,
                             String entityGuid)
                      throws MetadataServerUncontactableException,
                             UserNotAuthorizedException,
                             InvalidParameterException,
                             UnrecognizedGUIDException,
                             EntityNotDeletedException,
                             GUIDNotPurgedException
```
Purge an asset identified by its GUID. Delete is a hard delete, this means that the asset is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the asset

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreAsset
```
public Asset restoreAsset(String userId,
                          String entityGuid)
                   throws MetadataServerUncontactableException,
                          UserNotAuthorizedException,
                          InvalidParameterException,
                          UnrecognizedGUIDException,
                          GUIDNotDeletedException,
                          FunctionNotSupportedException
```
Restore an Asset identified by its GUID. Restore resurrects a soft deleted Asset. When a Asset was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the Asset

Returns:

Asset the restored Asset

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the Asset is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addAssetClassifications

public Asset addAssetClassifications(String userId,
                                     String entityGuid,
                                     List<Classification> classifications)
                              throws MetadataServerUncontactableException,
                                     UserNotAuthorizedException,
                                     InvalidParameterException,
                                     ClassificationException,
                                     UnrecognizedGUIDException

Add classifications to the supplied asset

Parameters:: userId - user identity; entityGuid - the GUID value for asset; classifications - the classifications to apply.
Returns:: the asset entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateAssetClassification
```
public Asset updateAssetClassification(String userId,
                                       String entityGuid,
                                       List<Classification> classificationsToUpdate)
                                throws MetadataServerUncontactableException,
                                       UserNotAuthorizedException,
                                       InvalidParameterException,
                                       ClassificationException,
                                       UnrecognizedGUIDException
```
Updates classifications to an existing asset represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the asset

classificationsToUpdate - List of classifications to update entity with

Returns:

classification for the given asset guid

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

ClassificationException - a classification does not match constraints.

deleteAssetClassification

public Asset deleteAssetClassification(String userId,
                                       String entityGuid,
                                       String name)
                                throws MetadataServerUncontactableException,
                                       UserNotAuthorizedException,
                                       InvalidParameterException,
                                       ClassificationException,
                                       UnrecognizedGUIDException

Deletes a given classification from an existing asset represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the asset; name - name of the classification
Returns:: deleted Asset classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getAssetRelationships
```
public Set<Line> getAssetRelationships(String userId,
                                       String entityGuid,
                                       String relationshipTypeGuid,
                                       int fromRelationshipElement,
                                       Date asOfTime,
                                       String sequencingProperty,
                                       SequencingOrder sequencingOrder,
                                       int pageSize)
                                throws MetadataServerUncontactableException,
                                       UserNotAuthorizedException,
                                       InvalidParameterException,
                                       FunctionNotSupportedException,
                                       UnrecognizedGUIDException
```
Get the relationships associated with entity asset represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the asset

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getAPIOperationById
```
public APIOperation getAPIOperationById(String userId,
                                        String entityGuid)
                                 throws MetadataServerUncontactableException,
                                        UserNotAuthorizedException,
                                        InvalidParameterException,
                                        UnrecognizedGUIDException
```
Fetch complete definition of an aPIOperation given its GUID. The limit and offset paging parameters limit the number elements returned in each of the aPIOperations relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

APIOperation the APIOperation entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createAPIOperation

public APIOperation createAPIOperation(String userId,
                                       APIOperation aPIOperation)
                                throws MetadataServerUncontactableException,
                                       UserNotAuthorizedException,
                                       InvalidParameterException,
                                       ClassificationException,
                                       StatusNotSupportedException

Create new aPIOperation.

Parameters:: userId - user identity; aPIOperation - the input entity with values.
Returns:: APIOperation the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateAPIOperation
```
public APIOperation updateAPIOperation(String userId,
                                       APIOperation aPIOperation)
                                throws MetadataServerUncontactableException,
                                       UserNotAuthorizedException,
                                       InvalidParameterException,
                                       UnrecognizedGUIDException
```
Update aPIOperation

Parameters:

userId - user identity

aPIOperation - aPIOperation to update

Returns:

APIOperation the updated aPIOperation entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteAPIOperationByGuid
```
public EntityDetail deleteAPIOperationByGuid(String userId,
                                             String entityGuid)
                                      throws MetadataServerUncontactableException,
                                             UserNotAuthorizedException,
                                             FunctionNotSupportedException,
                                             InvalidParameterException,
                                             UnrecognizedGUIDException
```
Delete an aPIOperation identified by its GUID. Delete is a soft delete, this means that the aPIOperation has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the aPIOperation

Returns:

APIOperation the deleted APIOperation entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeAPIOperationByGuid
```
public void purgeAPIOperationByGuid(String userId,
                                    String entityGuid)
                             throws MetadataServerUncontactableException,
                                    UserNotAuthorizedException,
                                    InvalidParameterException,
                                    UnrecognizedGUIDException,
                                    EntityNotDeletedException,
                                    GUIDNotPurgedException
```
Purge an aPIOperation identified by its GUID. Delete is a hard delete, this means that the aPIOperation is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the aPIOperation

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreAPIOperation
```
public APIOperation restoreAPIOperation(String userId,
                                        String entityGuid)
                                 throws MetadataServerUncontactableException,
                                        UserNotAuthorizedException,
                                        InvalidParameterException,
                                        UnrecognizedGUIDException,
                                        GUIDNotDeletedException,
                                        FunctionNotSupportedException
```
Restore an APIOperation identified by its GUID. Restore resurrects a soft deleted APIOperation. When a APIOperation was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the APIOperation

Returns:

APIOperation the restored APIOperation

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the APIOperation is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addAPIOperationClassifications

public APIOperation addAPIOperationClassifications(String userId,
                                                   String entityGuid,
                                                   List<Classification> classifications)
                                            throws MetadataServerUncontactableException,
                                                   UserNotAuthorizedException,
                                                   InvalidParameterException,
                                                   ClassificationException,
                                                   UnrecognizedGUIDException

Add classifications to the supplied aPIOperation

Parameters:: userId - user identity; entityGuid - the GUID value for aPIOperation; classifications - the classifications to apply.
Returns:: the aPIOperation entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateAPIOperationClassification

public APIOperation updateAPIOperationClassification(String userId,
                                                     String entityGuid,
                                                     List<Classification> classificationsToUpdate)
                                              throws MetadataServerUncontactableException,
                                                     UserNotAuthorizedException,
                                                     InvalidParameterException,
                                                     ClassificationException,
                                                     UnrecognizedGUIDException

Updates classifications to an existing aPIOperation represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the aPIOperation; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given aPIOperation guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteAPIOperationClassification

public APIOperation deleteAPIOperationClassification(String userId,
                                                     String entityGuid,
                                                     String name)
                                              throws MetadataServerUncontactableException,
                                                     UserNotAuthorizedException,
                                                     InvalidParameterException,
                                                     ClassificationException,
                                                     UnrecognizedGUIDException

Deletes a given classification from an existing aPIOperation represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the aPIOperation; name - name of the classification
Returns:: deleted APIOperation classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getAPIOperationRelationships
```
public Set<Line> getAPIOperationRelationships(String userId,
                                              String entityGuid,
                                              String relationshipTypeGuid,
                                              int fromRelationshipElement,
                                              Date asOfTime,
                                              String sequencingProperty,
                                              SequencingOrder sequencingOrder,
                                              int pageSize)
                                       throws MetadataServerUncontactableException,
                                              UserNotAuthorizedException,
                                              InvalidParameterException,
                                              FunctionNotSupportedException,
                                              UnrecognizedGUIDException
```
Get the relationships associated with entity aPIOperation represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the aPIOperation

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getToDoById
```
public ToDo getToDoById(String userId,
                        String entityGuid)
                 throws MetadataServerUncontactableException,
                        UserNotAuthorizedException,
                        InvalidParameterException,
                        UnrecognizedGUIDException
```
Fetch complete definition of an toDo given its GUID. The limit and offset paging parameters limit the number elements returned in each of the toDos relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

ToDo the ToDo entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createToDo
```
public ToDo createToDo(String userId,
                       ToDo toDo)
                throws MetadataServerUncontactableException,
                       UserNotAuthorizedException,
                       InvalidParameterException,
                       ClassificationException,
                       StatusNotSupportedException
```
Create new toDo.

Parameters:

userId - user identity

toDo - the input entity with values.

Returns:

ToDo the created entity.

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

ClassificationException - a classification does not match constraints.

StatusNotSupportedException - status is not supported

updateToDo
```
public ToDo updateToDo(String userId,
                       ToDo toDo)
                throws MetadataServerUncontactableException,
                       UserNotAuthorizedException,
                       InvalidParameterException,
                       UnrecognizedGUIDException
```
Update toDo

Parameters:

userId - user identity

toDo - toDo to update

Returns:

ToDo the updated toDo entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteToDoByGuid
```
public EntityDetail deleteToDoByGuid(String userId,
                                     String entityGuid)
                              throws MetadataServerUncontactableException,
                                     UserNotAuthorizedException,
                                     FunctionNotSupportedException,
                                     InvalidParameterException,
                                     UnrecognizedGUIDException
```
Delete an toDo identified by its GUID. Delete is a soft delete, this means that the toDo has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the toDo

Returns:

ToDo the deleted ToDo entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeToDoByGuid
```
public void purgeToDoByGuid(String userId,
                            String entityGuid)
                     throws MetadataServerUncontactableException,
                            UserNotAuthorizedException,
                            InvalidParameterException,
                            UnrecognizedGUIDException,
                            EntityNotDeletedException,
                            GUIDNotPurgedException
```
Purge an toDo identified by its GUID. Delete is a hard delete, this means that the toDo is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the toDo

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreToDo
```
public ToDo restoreToDo(String userId,
                        String entityGuid)
                 throws MetadataServerUncontactableException,
                        UserNotAuthorizedException,
                        InvalidParameterException,
                        UnrecognizedGUIDException,
                        GUIDNotDeletedException,
                        FunctionNotSupportedException
```
Restore an ToDo identified by its GUID. Restore resurrects a soft deleted ToDo. When a ToDo was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the ToDo

Returns:

ToDo the restored ToDo

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the ToDo is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addToDoClassifications

public ToDo addToDoClassifications(String userId,
                                   String entityGuid,
                                   List<Classification> classifications)
                            throws MetadataServerUncontactableException,
                                   UserNotAuthorizedException,
                                   InvalidParameterException,
                                   ClassificationException,
                                   UnrecognizedGUIDException

Add classifications to the supplied toDo

Parameters:: userId - user identity; entityGuid - the GUID value for toDo; classifications - the classifications to apply.
Returns:: the toDo entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateToDoClassification
```
public ToDo updateToDoClassification(String userId,
                                     String entityGuid,
                                     List<Classification> classificationsToUpdate)
                              throws MetadataServerUncontactableException,
                                     UserNotAuthorizedException,
                                     InvalidParameterException,
                                     ClassificationException,
                                     UnrecognizedGUIDException
```
Updates classifications to an existing toDo represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the toDo

classificationsToUpdate - List of classifications to update entity with

Returns:

classification for the given toDo guid

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

ClassificationException - a classification does not match constraints.

deleteToDoClassification
```
public ToDo deleteToDoClassification(String userId,
                                     String entityGuid,
                                     String name)
                              throws MetadataServerUncontactableException,
                                     UserNotAuthorizedException,
                                     InvalidParameterException,
                                     ClassificationException,
                                     UnrecognizedGUIDException
```
Deletes a given classification from an existing toDo represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the toDo

name - name of the classification

Returns:

deleted ToDo classification

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

ClassificationException - a classification does not match constraints.

getToDoRelationships
```
public Set<Line> getToDoRelationships(String userId,
                                      String entityGuid,
                                      String relationshipTypeGuid,
                                      int fromRelationshipElement,
                                      Date asOfTime,
                                      String sequencingProperty,
                                      SequencingOrder sequencingOrder,
                                      int pageSize)
                               throws MetadataServerUncontactableException,
                                      UserNotAuthorizedException,
                                      InvalidParameterException,
                                      FunctionNotSupportedException,
                                      UnrecognizedGUIDException
```
Get the relationships associated with entity toDo represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the toDo

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getNetworkGatewayById
```
public NetworkGateway getNetworkGatewayById(String userId,
                                            String entityGuid)
                                     throws MetadataServerUncontactableException,
                                            UserNotAuthorizedException,
                                            InvalidParameterException,
                                            UnrecognizedGUIDException
```
Fetch complete definition of an networkGateway given its GUID. The limit and offset paging parameters limit the number elements returned in each of the networkGatewaies relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

NetworkGateway the NetworkGateway entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createNetworkGateway

public NetworkGateway createNetworkGateway(String userId,
                                           NetworkGateway networkGateway)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           InvalidParameterException,
                                           ClassificationException,
                                           StatusNotSupportedException

Create new networkGateway.

Parameters:: userId - user identity; networkGateway - the input entity with values.
Returns:: NetworkGateway the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateNetworkGateway

public NetworkGateway updateNetworkGateway(String userId,
                                           NetworkGateway networkGateway)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           InvalidParameterException,
                                           UnrecognizedGUIDException

Update networkGateway

Parameters:: userId - user identity; networkGateway - networkGateway to update
Returns:: NetworkGateway the updated networkGateway entity
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteNetworkGatewayByGuid
```
public EntityDetail deleteNetworkGatewayByGuid(String userId,
                                               String entityGuid)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               FunctionNotSupportedException,
                                               InvalidParameterException,
                                               UnrecognizedGUIDException
```
Delete an networkGateway identified by its GUID. Delete is a soft delete, this means that the networkGateway has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the networkGateway

Returns:

NetworkGateway the deleted NetworkGateway entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeNetworkGatewayByGuid
```
public void purgeNetworkGatewayByGuid(String userId,
                                      String entityGuid)
                               throws MetadataServerUncontactableException,
                                      UserNotAuthorizedException,
                                      InvalidParameterException,
                                      UnrecognizedGUIDException,
                                      EntityNotDeletedException,
                                      GUIDNotPurgedException
```
Purge an networkGateway identified by its GUID. Delete is a hard delete, this means that the networkGateway is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the networkGateway

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreNetworkGateway
```
public NetworkGateway restoreNetworkGateway(String userId,
                                            String entityGuid)
                                     throws MetadataServerUncontactableException,
                                            UserNotAuthorizedException,
                                            InvalidParameterException,
                                            UnrecognizedGUIDException,
                                            GUIDNotDeletedException,
                                            FunctionNotSupportedException
```
Restore an NetworkGateway identified by its GUID. Restore resurrects a soft deleted NetworkGateway. When a NetworkGateway was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the NetworkGateway

Returns:

NetworkGateway the restored NetworkGateway

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the NetworkGateway is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addNetworkGatewayClassifications

public NetworkGateway addNetworkGatewayClassifications(String userId,
                                                       String entityGuid,
                                                       List<Classification> classifications)
                                                throws MetadataServerUncontactableException,
                                                       UserNotAuthorizedException,
                                                       InvalidParameterException,
                                                       ClassificationException,
                                                       UnrecognizedGUIDException

Add classifications to the supplied networkGateway

Parameters:: userId - user identity; entityGuid - the GUID value for networkGateway; classifications - the classifications to apply.
Returns:: the networkGateway entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateNetworkGatewayClassification

public NetworkGateway updateNetworkGatewayClassification(String userId,
                                                         String entityGuid,
                                                         List<Classification> classificationsToUpdate)
                                                  throws MetadataServerUncontactableException,
                                                         UserNotAuthorizedException,
                                                         InvalidParameterException,
                                                         ClassificationException,
                                                         UnrecognizedGUIDException

Updates classifications to an existing networkGateway represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the networkGateway; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given networkGateway guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteNetworkGatewayClassification

public NetworkGateway deleteNetworkGatewayClassification(String userId,
                                                         String entityGuid,
                                                         String name)
                                                  throws MetadataServerUncontactableException,
                                                         UserNotAuthorizedException,
                                                         InvalidParameterException,
                                                         ClassificationException,
                                                         UnrecognizedGUIDException

Deletes a given classification from an existing networkGateway represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the networkGateway; name - name of the classification
Returns:: deleted NetworkGateway classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getNetworkGatewayRelationships
```
public Set<Line> getNetworkGatewayRelationships(String userId,
                                                String entityGuid,
                                                String relationshipTypeGuid,
                                                int fromRelationshipElement,
                                                Date asOfTime,
                                                String sequencingProperty,
                                                SequencingOrder sequencingOrder,
                                                int pageSize)
                                         throws MetadataServerUncontactableException,
                                                UserNotAuthorizedException,
                                                InvalidParameterException,
                                                FunctionNotSupportedException,
                                                UnrecognizedGUIDException
```
Get the relationships associated with entity networkGateway represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the networkGateway

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getGovernanceResponsibilityById
```
public GovernanceResponsibility getGovernanceResponsibilityById(String userId,
                                                                String entityGuid)
                                                         throws MetadataServerUncontactableException,
                                                                UserNotAuthorizedException,
                                                                InvalidParameterException,
                                                                UnrecognizedGUIDException
```
Fetch complete definition of an governanceResponsibility given its GUID. The limit and offset paging parameters limit the number elements returned in each of the governanceResponsibilities relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

GovernanceResponsibility the GovernanceResponsibility entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createGovernanceResponsibility

public GovernanceResponsibility createGovernanceResponsibility(String userId,
                                                               GovernanceResponsibility governanceResponsibility)
                                                        throws MetadataServerUncontactableException,
                                                               UserNotAuthorizedException,
                                                               InvalidParameterException,
                                                               ClassificationException,
                                                               StatusNotSupportedException

Create new governanceResponsibility.

Parameters:: userId - user identity; governanceResponsibility - the input entity with values.
Returns:: GovernanceResponsibility the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateGovernanceResponsibility

public GovernanceResponsibility updateGovernanceResponsibility(String userId,
                                                               GovernanceResponsibility governanceResponsibility)
                                                        throws MetadataServerUncontactableException,
                                                               UserNotAuthorizedException,
                                                               InvalidParameterException,
                                                               UnrecognizedGUIDException

Update governanceResponsibility

Parameters:: userId - user identity; governanceResponsibility - governanceResponsibility to update
Returns:: GovernanceResponsibility the updated governanceResponsibility entity
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteGovernanceResponsibilityByGuid
```
public EntityDetail deleteGovernanceResponsibilityByGuid(String userId,
                                                         String entityGuid)
                                                  throws MetadataServerUncontactableException,
                                                         UserNotAuthorizedException,
                                                         FunctionNotSupportedException,
                                                         InvalidParameterException,
                                                         UnrecognizedGUIDException
```
Delete an governanceResponsibility identified by its GUID. Delete is a soft delete, this means that the governanceResponsibility has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the governanceResponsibility

Returns:

GovernanceResponsibility the deleted GovernanceResponsibility entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeGovernanceResponsibilityByGuid

public void purgeGovernanceResponsibilityByGuid(String userId,
                                                String entityGuid)
                                         throws MetadataServerUncontactableException,
                                                UserNotAuthorizedException,
                                                InvalidParameterException,
                                                UnrecognizedGUIDException,
                                                EntityNotDeletedException,
                                                GUIDNotPurgedException

Purge an governanceResponsibility identified by its GUID. Delete is a hard delete, this means that the governanceResponsibility is really deleted .

Parameters:: userId - user identity; entityGuid - GUID for the governanceResponsibility
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; EntityNotDeletedException - the entity was not deleted; GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreGovernanceResponsibility

public GovernanceResponsibility restoreGovernanceResponsibility(String userId,
                                                                String entityGuid)
                                                         throws MetadataServerUncontactableException,
                                                                UserNotAuthorizedException,
                                                                InvalidParameterException,
                                                                UnrecognizedGUIDException,
                                                                GUIDNotDeletedException,
                                                                FunctionNotSupportedException

Restore an GovernanceResponsibility identified by its GUID. Restore resurrects a soft deleted GovernanceResponsibility. When a GovernanceResponsibility was incorrectly deleted, the delete can be undone using the restore..

Parameters:: userId - user identity; entityGuid - GUID for the GovernanceResponsibility
Returns:: GovernanceResponsibility the restored GovernanceResponsibility
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; GUIDNotDeletedException - the guid of the GovernanceResponsibility is not deleted, so cannot be restored; FunctionNotSupportedException - Function not supported

addGovernanceResponsibilityClassifications

public GovernanceResponsibility addGovernanceResponsibilityClassifications(String userId,
                                                                           String entityGuid,
                                                                           List<Classification> classifications)
                                                                    throws MetadataServerUncontactableException,
                                                                           UserNotAuthorizedException,
                                                                           InvalidParameterException,
                                                                           ClassificationException,
                                                                           UnrecognizedGUIDException

Add classifications to the supplied governanceResponsibility

Parameters:: userId - user identity; entityGuid - the GUID value for governanceResponsibility; classifications - the classifications to apply.
Returns:: the governanceResponsibility entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateGovernanceResponsibilityClassification

public GovernanceResponsibility updateGovernanceResponsibilityClassification(String userId,
                                                                             String entityGuid,
                                                                             List<Classification> classificationsToUpdate)
                                                                      throws MetadataServerUncontactableException,
                                                                             UserNotAuthorizedException,
                                                                             InvalidParameterException,
                                                                             ClassificationException,
                                                                             UnrecognizedGUIDException

Updates classifications to an existing governanceResponsibility represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the governanceResponsibility; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given governanceResponsibility guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteGovernanceResponsibilityClassification

public GovernanceResponsibility deleteGovernanceResponsibilityClassification(String userId,
                                                                             String entityGuid,
                                                                             String name)
                                                                      throws MetadataServerUncontactableException,
                                                                             UserNotAuthorizedException,
                                                                             InvalidParameterException,
                                                                             ClassificationException,
                                                                             UnrecognizedGUIDException

Deletes a given classification from an existing governanceResponsibility represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the governanceResponsibility; name - name of the classification
Returns:: deleted GovernanceResponsibility classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getGovernanceResponsibilityRelationships
```
public Set<Line> getGovernanceResponsibilityRelationships(String userId,
                                                          String entityGuid,
                                                          String relationshipTypeGuid,
                                                          int fromRelationshipElement,
                                                          Date asOfTime,
                                                          String sequencingProperty,
                                                          SequencingOrder sequencingOrder,
                                                          int pageSize)
                                                   throws MetadataServerUncontactableException,
                                                          UserNotAuthorizedException,
                                                          InvalidParameterException,
                                                          FunctionNotSupportedException,
                                                          UnrecognizedGUIDException
```
Get the relationships associated with entity governanceResponsibility represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the governanceResponsibility

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getImplementationSnippetById
```
public ImplementationSnippet getImplementationSnippetById(String userId,
                                                          String entityGuid)
                                                   throws MetadataServerUncontactableException,
                                                          UserNotAuthorizedException,
                                                          InvalidParameterException,
                                                          UnrecognizedGUIDException
```
Fetch complete definition of an implementationSnippet given its GUID. The limit and offset paging parameters limit the number elements returned in each of the implementationSnippets relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

ImplementationSnippet the ImplementationSnippet entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createImplementationSnippet

public ImplementationSnippet createImplementationSnippet(String userId,
                                                         ImplementationSnippet implementationSnippet)
                                                  throws MetadataServerUncontactableException,
                                                         UserNotAuthorizedException,
                                                         InvalidParameterException,
                                                         ClassificationException,
                                                         StatusNotSupportedException

Create new implementationSnippet.

Parameters:: userId - user identity; implementationSnippet - the input entity with values.
Returns:: ImplementationSnippet the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateImplementationSnippet

public ImplementationSnippet updateImplementationSnippet(String userId,
                                                         ImplementationSnippet implementationSnippet)
                                                  throws MetadataServerUncontactableException,
                                                         UserNotAuthorizedException,
                                                         InvalidParameterException,
                                                         UnrecognizedGUIDException

Update implementationSnippet

Parameters:: userId - user identity; implementationSnippet - implementationSnippet to update
Returns:: ImplementationSnippet the updated implementationSnippet entity
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteImplementationSnippetByGuid
```
public EntityDetail deleteImplementationSnippetByGuid(String userId,
                                                      String entityGuid)
                                               throws MetadataServerUncontactableException,
                                                      UserNotAuthorizedException,
                                                      FunctionNotSupportedException,
                                                      InvalidParameterException,
                                                      UnrecognizedGUIDException
```
Delete an implementationSnippet identified by its GUID. Delete is a soft delete, this means that the implementationSnippet has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the implementationSnippet

Returns:

ImplementationSnippet the deleted ImplementationSnippet entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeImplementationSnippetByGuid
```
public void purgeImplementationSnippetByGuid(String userId,
                                             String entityGuid)
                                      throws MetadataServerUncontactableException,
                                             UserNotAuthorizedException,
                                             InvalidParameterException,
                                             UnrecognizedGUIDException,
                                             EntityNotDeletedException,
                                             GUIDNotPurgedException
```
Purge an implementationSnippet identified by its GUID. Delete is a hard delete, this means that the implementationSnippet is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the implementationSnippet

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreImplementationSnippet

public ImplementationSnippet restoreImplementationSnippet(String userId,
                                                          String entityGuid)
                                                   throws MetadataServerUncontactableException,
                                                          UserNotAuthorizedException,
                                                          InvalidParameterException,
                                                          UnrecognizedGUIDException,
                                                          GUIDNotDeletedException,
                                                          FunctionNotSupportedException

Restore an ImplementationSnippet identified by its GUID. Restore resurrects a soft deleted ImplementationSnippet. When a ImplementationSnippet was incorrectly deleted, the delete can be undone using the restore..

Parameters:: userId - user identity; entityGuid - GUID for the ImplementationSnippet
Returns:: ImplementationSnippet the restored ImplementationSnippet
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; GUIDNotDeletedException - the guid of the ImplementationSnippet is not deleted, so cannot be restored; FunctionNotSupportedException - Function not supported

addImplementationSnippetClassifications

public ImplementationSnippet addImplementationSnippetClassifications(String userId,
                                                                     String entityGuid,
                                                                     List<Classification> classifications)
                                                              throws MetadataServerUncontactableException,
                                                                     UserNotAuthorizedException,
                                                                     InvalidParameterException,
                                                                     ClassificationException,
                                                                     UnrecognizedGUIDException

Add classifications to the supplied implementationSnippet

Parameters:: userId - user identity; entityGuid - the GUID value for implementationSnippet; classifications - the classifications to apply.
Returns:: the implementationSnippet entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateImplementationSnippetClassification

public ImplementationSnippet updateImplementationSnippetClassification(String userId,
                                                                       String entityGuid,
                                                                       List<Classification> classificationsToUpdate)
                                                                throws MetadataServerUncontactableException,
                                                                       UserNotAuthorizedException,
                                                                       InvalidParameterException,
                                                                       ClassificationException,
                                                                       UnrecognizedGUIDException

Updates classifications to an existing implementationSnippet represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the implementationSnippet; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given implementationSnippet guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteImplementationSnippetClassification

public ImplementationSnippet deleteImplementationSnippetClassification(String userId,
                                                                       String entityGuid,
                                                                       String name)
                                                                throws MetadataServerUncontactableException,
                                                                       UserNotAuthorizedException,
                                                                       InvalidParameterException,
                                                                       ClassificationException,
                                                                       UnrecognizedGUIDException

Deletes a given classification from an existing implementationSnippet represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the implementationSnippet; name - name of the classification
Returns:: deleted ImplementationSnippet classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getImplementationSnippetRelationships
```
public Set<Line> getImplementationSnippetRelationships(String userId,
                                                       String entityGuid,
                                                       String relationshipTypeGuid,
                                                       int fromRelationshipElement,
                                                       Date asOfTime,
                                                       String sequencingProperty,
                                                       SequencingOrder sequencingOrder,
                                                       int pageSize)
                                                throws MetadataServerUncontactableException,
                                                       UserNotAuthorizedException,
                                                       InvalidParameterException,
                                                       FunctionNotSupportedException,
                                                       UnrecognizedGUIDException
```
Get the relationships associated with entity implementationSnippet represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the implementationSnippet

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getUserIdentityById
```
public UserIdentity getUserIdentityById(String userId,
                                        String entityGuid)
                                 throws MetadataServerUncontactableException,
                                        UserNotAuthorizedException,
                                        InvalidParameterException,
                                        UnrecognizedGUIDException
```
Fetch complete definition of an userIdentity given its GUID. The limit and offset paging parameters limit the number elements returned in each of the userIdentities relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

UserIdentity the UserIdentity entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createUserIdentity

public UserIdentity createUserIdentity(String userId,
                                       UserIdentity userIdentity)
                                throws MetadataServerUncontactableException,
                                       UserNotAuthorizedException,
                                       InvalidParameterException,
                                       ClassificationException,
                                       StatusNotSupportedException

Create new userIdentity.

Parameters:: userId - user identity; userIdentity - the input entity with values.
Returns:: UserIdentity the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateUserIdentity
```
public UserIdentity updateUserIdentity(String userId,
                                       UserIdentity userIdentity)
                                throws MetadataServerUncontactableException,
                                       UserNotAuthorizedException,
                                       InvalidParameterException,
                                       UnrecognizedGUIDException
```
Update userIdentity

Parameters:

userId - user identity

userIdentity - userIdentity to update

Returns:

UserIdentity the updated userIdentity entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteUserIdentityByGuid
```
public EntityDetail deleteUserIdentityByGuid(String userId,
                                             String entityGuid)
                                      throws MetadataServerUncontactableException,
                                             UserNotAuthorizedException,
                                             FunctionNotSupportedException,
                                             InvalidParameterException,
                                             UnrecognizedGUIDException
```
Delete an userIdentity identified by its GUID. Delete is a soft delete, this means that the userIdentity has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the userIdentity

Returns:

UserIdentity the deleted UserIdentity entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeUserIdentityByGuid
```
public void purgeUserIdentityByGuid(String userId,
                                    String entityGuid)
                             throws MetadataServerUncontactableException,
                                    UserNotAuthorizedException,
                                    InvalidParameterException,
                                    UnrecognizedGUIDException,
                                    EntityNotDeletedException,
                                    GUIDNotPurgedException
```
Purge an userIdentity identified by its GUID. Delete is a hard delete, this means that the userIdentity is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the userIdentity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreUserIdentity
```
public UserIdentity restoreUserIdentity(String userId,
                                        String entityGuid)
                                 throws MetadataServerUncontactableException,
                                        UserNotAuthorizedException,
                                        InvalidParameterException,
                                        UnrecognizedGUIDException,
                                        GUIDNotDeletedException,
                                        FunctionNotSupportedException
```
Restore an UserIdentity identified by its GUID. Restore resurrects a soft deleted UserIdentity. When a UserIdentity was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the UserIdentity

Returns:

UserIdentity the restored UserIdentity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the UserIdentity is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addUserIdentityClassifications

public UserIdentity addUserIdentityClassifications(String userId,
                                                   String entityGuid,
                                                   List<Classification> classifications)
                                            throws MetadataServerUncontactableException,
                                                   UserNotAuthorizedException,
                                                   InvalidParameterException,
                                                   ClassificationException,
                                                   UnrecognizedGUIDException

Add classifications to the supplied userIdentity

Parameters:: userId - user identity; entityGuid - the GUID value for userIdentity; classifications - the classifications to apply.
Returns:: the userIdentity entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateUserIdentityClassification

public UserIdentity updateUserIdentityClassification(String userId,
                                                     String entityGuid,
                                                     List<Classification> classificationsToUpdate)
                                              throws MetadataServerUncontactableException,
                                                     UserNotAuthorizedException,
                                                     InvalidParameterException,
                                                     ClassificationException,
                                                     UnrecognizedGUIDException

Updates classifications to an existing userIdentity represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the userIdentity; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given userIdentity guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteUserIdentityClassification

public UserIdentity deleteUserIdentityClassification(String userId,
                                                     String entityGuid,
                                                     String name)
                                              throws MetadataServerUncontactableException,
                                                     UserNotAuthorizedException,
                                                     InvalidParameterException,
                                                     ClassificationException,
                                                     UnrecognizedGUIDException

Deletes a given classification from an existing userIdentity represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the userIdentity; name - name of the classification
Returns:: deleted UserIdentity classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getUserIdentityRelationships
```
public Set<Line> getUserIdentityRelationships(String userId,
                                              String entityGuid,
                                              String relationshipTypeGuid,
                                              int fromRelationshipElement,
                                              Date asOfTime,
                                              String sequencingProperty,
                                              SequencingOrder sequencingOrder,
                                              int pageSize)
                                       throws MetadataServerUncontactableException,
                                              UserNotAuthorizedException,
                                              InvalidParameterException,
                                              FunctionNotSupportedException,
                                              UnrecognizedGUIDException
```
Get the relationships associated with entity userIdentity represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the userIdentity

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getNoteEntryById
```
public NoteEntry getNoteEntryById(String userId,
                                  String entityGuid)
                           throws MetadataServerUncontactableException,
                                  UserNotAuthorizedException,
                                  InvalidParameterException,
                                  UnrecognizedGUIDException
```
Fetch complete definition of an noteEntry given its GUID. The limit and offset paging parameters limit the number elements returned in each of the noteEntries relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

NoteEntry the NoteEntry entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createNoteEntry

public NoteEntry createNoteEntry(String userId,
                                 NoteEntry noteEntry)
                          throws MetadataServerUncontactableException,
                                 UserNotAuthorizedException,
                                 InvalidParameterException,
                                 ClassificationException,
                                 StatusNotSupportedException

Create new noteEntry.

Parameters:: userId - user identity; noteEntry - the input entity with values.
Returns:: NoteEntry the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateNoteEntry
```
public NoteEntry updateNoteEntry(String userId,
                                 NoteEntry noteEntry)
                          throws MetadataServerUncontactableException,
                                 UserNotAuthorizedException,
                                 InvalidParameterException,
                                 UnrecognizedGUIDException
```
Update noteEntry

Parameters:

userId - user identity

noteEntry - noteEntry to update

Returns:

NoteEntry the updated noteEntry entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteNoteEntryByGuid
```
public EntityDetail deleteNoteEntryByGuid(String userId,
                                          String entityGuid)
                                   throws MetadataServerUncontactableException,
                                          UserNotAuthorizedException,
                                          FunctionNotSupportedException,
                                          InvalidParameterException,
                                          UnrecognizedGUIDException
```
Delete an noteEntry identified by its GUID. Delete is a soft delete, this means that the noteEntry has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the noteEntry

Returns:

NoteEntry the deleted NoteEntry entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeNoteEntryByGuid
```
public void purgeNoteEntryByGuid(String userId,
                                 String entityGuid)
                          throws MetadataServerUncontactableException,
                                 UserNotAuthorizedException,
                                 InvalidParameterException,
                                 UnrecognizedGUIDException,
                                 EntityNotDeletedException,
                                 GUIDNotPurgedException
```
Purge an noteEntry identified by its GUID. Delete is a hard delete, this means that the noteEntry is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the noteEntry

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreNoteEntry
```
public NoteEntry restoreNoteEntry(String userId,
                                  String entityGuid)
                           throws MetadataServerUncontactableException,
                                  UserNotAuthorizedException,
                                  InvalidParameterException,
                                  UnrecognizedGUIDException,
                                  GUIDNotDeletedException,
                                  FunctionNotSupportedException
```
Restore an NoteEntry identified by its GUID. Restore resurrects a soft deleted NoteEntry. When a NoteEntry was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the NoteEntry

Returns:

NoteEntry the restored NoteEntry

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the NoteEntry is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addNoteEntryClassifications

public NoteEntry addNoteEntryClassifications(String userId,
                                             String entityGuid,
                                             List<Classification> classifications)
                                      throws MetadataServerUncontactableException,
                                             UserNotAuthorizedException,
                                             InvalidParameterException,
                                             ClassificationException,
                                             UnrecognizedGUIDException

Add classifications to the supplied noteEntry

Parameters:: userId - user identity; entityGuid - the GUID value for noteEntry; classifications - the classifications to apply.
Returns:: the noteEntry entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateNoteEntryClassification

public NoteEntry updateNoteEntryClassification(String userId,
                                               String entityGuid,
                                               List<Classification> classificationsToUpdate)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               InvalidParameterException,
                                               ClassificationException,
                                               UnrecognizedGUIDException

Updates classifications to an existing noteEntry represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the noteEntry; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given noteEntry guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteNoteEntryClassification

public NoteEntry deleteNoteEntryClassification(String userId,
                                               String entityGuid,
                                               String name)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               InvalidParameterException,
                                               ClassificationException,
                                               UnrecognizedGUIDException

Deletes a given classification from an existing noteEntry represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the noteEntry; name - name of the classification
Returns:: deleted NoteEntry classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getNoteEntryRelationships
```
public Set<Line> getNoteEntryRelationships(String userId,
                                           String entityGuid,
                                           String relationshipTypeGuid,
                                           int fromRelationshipElement,
                                           Date asOfTime,
                                           String sequencingProperty,
                                           SequencingOrder sequencingOrder,
                                           int pageSize)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           InvalidParameterException,
                                           FunctionNotSupportedException,
                                           UnrecognizedGUIDException
```
Get the relationships associated with entity noteEntry represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the noteEntry

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getPropertyFacetById
```
public PropertyFacet getPropertyFacetById(String userId,
                                          String entityGuid)
                                   throws MetadataServerUncontactableException,
                                          UserNotAuthorizedException,
                                          InvalidParameterException,
                                          UnrecognizedGUIDException
```
Fetch complete definition of an propertyFacet given its GUID. The limit and offset paging parameters limit the number elements returned in each of the propertyFacets relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

PropertyFacet the PropertyFacet entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createPropertyFacet

public PropertyFacet createPropertyFacet(String userId,
                                         PropertyFacet propertyFacet)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         InvalidParameterException,
                                         ClassificationException,
                                         StatusNotSupportedException

Create new propertyFacet.

Parameters:: userId - user identity; propertyFacet - the input entity with values.
Returns:: PropertyFacet the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updatePropertyFacet
```
public PropertyFacet updatePropertyFacet(String userId,
                                         PropertyFacet propertyFacet)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         InvalidParameterException,
                                         UnrecognizedGUIDException
```
Update propertyFacet

Parameters:

userId - user identity

propertyFacet - propertyFacet to update

Returns:

PropertyFacet the updated propertyFacet entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deletePropertyFacetByGuid
```
public EntityDetail deletePropertyFacetByGuid(String userId,
                                              String entityGuid)
                                       throws MetadataServerUncontactableException,
                                              UserNotAuthorizedException,
                                              FunctionNotSupportedException,
                                              InvalidParameterException,
                                              UnrecognizedGUIDException
```
Delete an propertyFacet identified by its GUID. Delete is a soft delete, this means that the propertyFacet has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the propertyFacet

Returns:

PropertyFacet the deleted PropertyFacet entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgePropertyFacetByGuid
```
public void purgePropertyFacetByGuid(String userId,
                                     String entityGuid)
                              throws MetadataServerUncontactableException,
                                     UserNotAuthorizedException,
                                     InvalidParameterException,
                                     UnrecognizedGUIDException,
                                     EntityNotDeletedException,
                                     GUIDNotPurgedException
```
Purge an propertyFacet identified by its GUID. Delete is a hard delete, this means that the propertyFacet is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the propertyFacet

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restorePropertyFacet
```
public PropertyFacet restorePropertyFacet(String userId,
                                          String entityGuid)
                                   throws MetadataServerUncontactableException,
                                          UserNotAuthorizedException,
                                          InvalidParameterException,
                                          UnrecognizedGUIDException,
                                          GUIDNotDeletedException,
                                          FunctionNotSupportedException
```
Restore an PropertyFacet identified by its GUID. Restore resurrects a soft deleted PropertyFacet. When a PropertyFacet was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the PropertyFacet

Returns:

PropertyFacet the restored PropertyFacet

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the PropertyFacet is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addPropertyFacetClassifications

public PropertyFacet addPropertyFacetClassifications(String userId,
                                                     String entityGuid,
                                                     List<Classification> classifications)
                                              throws MetadataServerUncontactableException,
                                                     UserNotAuthorizedException,
                                                     InvalidParameterException,
                                                     ClassificationException,
                                                     UnrecognizedGUIDException

Add classifications to the supplied propertyFacet

Parameters:: userId - user identity; entityGuid - the GUID value for propertyFacet; classifications - the classifications to apply.
Returns:: the propertyFacet entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updatePropertyFacetClassification

public PropertyFacet updatePropertyFacetClassification(String userId,
                                                       String entityGuid,
                                                       List<Classification> classificationsToUpdate)
                                                throws MetadataServerUncontactableException,
                                                       UserNotAuthorizedException,
                                                       InvalidParameterException,
                                                       ClassificationException,
                                                       UnrecognizedGUIDException

Updates classifications to an existing propertyFacet represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the propertyFacet; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given propertyFacet guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deletePropertyFacetClassification

public PropertyFacet deletePropertyFacetClassification(String userId,
                                                       String entityGuid,
                                                       String name)
                                                throws MetadataServerUncontactableException,
                                                       UserNotAuthorizedException,
                                                       InvalidParameterException,
                                                       ClassificationException,
                                                       UnrecognizedGUIDException

Deletes a given classification from an existing propertyFacet represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the propertyFacet; name - name of the classification
Returns:: deleted PropertyFacet classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getPropertyFacetRelationships
```
public Set<Line> getPropertyFacetRelationships(String userId,
                                               String entityGuid,
                                               String relationshipTypeGuid,
                                               int fromRelationshipElement,
                                               Date asOfTime,
                                               String sequencingProperty,
                                               SequencingOrder sequencingOrder,
                                               int pageSize)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               InvalidParameterException,
                                               FunctionNotSupportedException,
                                               UnrecognizedGUIDException
```
Get the relationships associated with entity propertyFacet represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the propertyFacet

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getProjectById
```
public Project getProjectById(String userId,
                              String entityGuid)
                       throws MetadataServerUncontactableException,
                              UserNotAuthorizedException,
                              InvalidParameterException,
                              UnrecognizedGUIDException
```
Fetch complete definition of an project given its GUID. The limit and offset paging parameters limit the number elements returned in each of the projects relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

Project the Project entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createProject

public Project createProject(String userId,
                             Project project)
                      throws MetadataServerUncontactableException,
                             UserNotAuthorizedException,
                             InvalidParameterException,
                             ClassificationException,
                             StatusNotSupportedException

Create new project.

Parameters:: userId - user identity; project - the input entity with values.
Returns:: Project the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateProject
```
public Project updateProject(String userId,
                             Project project)
                      throws MetadataServerUncontactableException,
                             UserNotAuthorizedException,
                             InvalidParameterException,
                             UnrecognizedGUIDException
```
Update project

Parameters:

userId - user identity

project - project to update

Returns:

Project the updated project entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteProjectByGuid
```
public EntityDetail deleteProjectByGuid(String userId,
                                        String entityGuid)
                                 throws MetadataServerUncontactableException,
                                        UserNotAuthorizedException,
                                        FunctionNotSupportedException,
                                        InvalidParameterException,
                                        UnrecognizedGUIDException
```
Delete an project identified by its GUID. Delete is a soft delete, this means that the project has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the project

Returns:

Project the deleted Project entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeProjectByGuid
```
public void purgeProjectByGuid(String userId,
                               String entityGuid)
                        throws MetadataServerUncontactableException,
                               UserNotAuthorizedException,
                               InvalidParameterException,
                               UnrecognizedGUIDException,
                               EntityNotDeletedException,
                               GUIDNotPurgedException
```
Purge an project identified by its GUID. Delete is a hard delete, this means that the project is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the project

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreProject
```
public Project restoreProject(String userId,
                              String entityGuid)
                       throws MetadataServerUncontactableException,
                              UserNotAuthorizedException,
                              InvalidParameterException,
                              UnrecognizedGUIDException,
                              GUIDNotDeletedException,
                              FunctionNotSupportedException
```
Restore an Project identified by its GUID. Restore resurrects a soft deleted Project. When a Project was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the Project

Returns:

Project the restored Project

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the Project is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addProjectClassifications

public Project addProjectClassifications(String userId,
                                         String entityGuid,
                                         List<Classification> classifications)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         InvalidParameterException,
                                         ClassificationException,
                                         UnrecognizedGUIDException

Add classifications to the supplied project

Parameters:: userId - user identity; entityGuid - the GUID value for project; classifications - the classifications to apply.
Returns:: the project entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateProjectClassification

public Project updateProjectClassification(String userId,
                                           String entityGuid,
                                           List<Classification> classificationsToUpdate)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           InvalidParameterException,
                                           ClassificationException,
                                           UnrecognizedGUIDException

Updates classifications to an existing project represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the project; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given project guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteProjectClassification

public Project deleteProjectClassification(String userId,
                                           String entityGuid,
                                           String name)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           InvalidParameterException,
                                           ClassificationException,
                                           UnrecognizedGUIDException

Deletes a given classification from an existing project represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the project; name - name of the classification
Returns:: deleted Project classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getProjectRelationships
```
public Set<Line> getProjectRelationships(String userId,
                                         String entityGuid,
                                         String relationshipTypeGuid,
                                         int fromRelationshipElement,
                                         Date asOfTime,
                                         String sequencingProperty,
                                         SequencingOrder sequencingOrder,
                                         int pageSize)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         InvalidParameterException,
                                         FunctionNotSupportedException,
                                         UnrecognizedGUIDException
```
Get the relationships associated with entity project represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the project

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getHostClusterById
```
public HostCluster getHostClusterById(String userId,
                                      String entityGuid)
                               throws MetadataServerUncontactableException,
                                      UserNotAuthorizedException,
                                      InvalidParameterException,
                                      UnrecognizedGUIDException
```
Fetch complete definition of an hostCluster given its GUID. The limit and offset paging parameters limit the number elements returned in each of the hostClusters relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

HostCluster the HostCluster entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createHostCluster

public HostCluster createHostCluster(String userId,
                                     HostCluster hostCluster)
                              throws MetadataServerUncontactableException,
                                     UserNotAuthorizedException,
                                     InvalidParameterException,
                                     ClassificationException,
                                     StatusNotSupportedException

Create new hostCluster.

Parameters:: userId - user identity; hostCluster - the input entity with values.
Returns:: HostCluster the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateHostCluster
```
public HostCluster updateHostCluster(String userId,
                                     HostCluster hostCluster)
                              throws MetadataServerUncontactableException,
                                     UserNotAuthorizedException,
                                     InvalidParameterException,
                                     UnrecognizedGUIDException
```
Update hostCluster

Parameters:

userId - user identity

hostCluster - hostCluster to update

Returns:

HostCluster the updated hostCluster entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteHostClusterByGuid
```
public EntityDetail deleteHostClusterByGuid(String userId,
                                            String entityGuid)
                                     throws MetadataServerUncontactableException,
                                            UserNotAuthorizedException,
                                            FunctionNotSupportedException,
                                            InvalidParameterException,
                                            UnrecognizedGUIDException
```
Delete an hostCluster identified by its GUID. Delete is a soft delete, this means that the hostCluster has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the hostCluster

Returns:

HostCluster the deleted HostCluster entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeHostClusterByGuid
```
public void purgeHostClusterByGuid(String userId,
                                   String entityGuid)
                            throws MetadataServerUncontactableException,
                                   UserNotAuthorizedException,
                                   InvalidParameterException,
                                   UnrecognizedGUIDException,
                                   EntityNotDeletedException,
                                   GUIDNotPurgedException
```
Purge an hostCluster identified by its GUID. Delete is a hard delete, this means that the hostCluster is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the hostCluster

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreHostCluster
```
public HostCluster restoreHostCluster(String userId,
                                      String entityGuid)
                               throws MetadataServerUncontactableException,
                                      UserNotAuthorizedException,
                                      InvalidParameterException,
                                      UnrecognizedGUIDException,
                                      GUIDNotDeletedException,
                                      FunctionNotSupportedException
```
Restore an HostCluster identified by its GUID. Restore resurrects a soft deleted HostCluster. When a HostCluster was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the HostCluster

Returns:

HostCluster the restored HostCluster

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the HostCluster is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addHostClusterClassifications

public HostCluster addHostClusterClassifications(String userId,
                                                 String entityGuid,
                                                 List<Classification> classifications)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 ClassificationException,
                                                 UnrecognizedGUIDException

Add classifications to the supplied hostCluster

Parameters:: userId - user identity; entityGuid - the GUID value for hostCluster; classifications - the classifications to apply.
Returns:: the hostCluster entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateHostClusterClassification

public HostCluster updateHostClusterClassification(String userId,
                                                   String entityGuid,
                                                   List<Classification> classificationsToUpdate)
                                            throws MetadataServerUncontactableException,
                                                   UserNotAuthorizedException,
                                                   InvalidParameterException,
                                                   ClassificationException,
                                                   UnrecognizedGUIDException

Updates classifications to an existing hostCluster represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the hostCluster; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given hostCluster guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteHostClusterClassification

public HostCluster deleteHostClusterClassification(String userId,
                                                   String entityGuid,
                                                   String name)
                                            throws MetadataServerUncontactableException,
                                                   UserNotAuthorizedException,
                                                   InvalidParameterException,
                                                   ClassificationException,
                                                   UnrecognizedGUIDException

Deletes a given classification from an existing hostCluster represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the hostCluster; name - name of the classification
Returns:: deleted HostCluster classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getHostClusterRelationships
```
public Set<Line> getHostClusterRelationships(String userId,
                                             String entityGuid,
                                             String relationshipTypeGuid,
                                             int fromRelationshipElement,
                                             Date asOfTime,
                                             String sequencingProperty,
                                             SequencingOrder sequencingOrder,
                                             int pageSize)
                                      throws MetadataServerUncontactableException,
                                             UserNotAuthorizedException,
                                             InvalidParameterException,
                                             FunctionNotSupportedException,
                                             UnrecognizedGUIDException
```
Get the relationships associated with entity hostCluster represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the hostCluster

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getGlossaryById
```
public Glossary getGlossaryById(String userId,
                                String entityGuid)
                         throws MetadataServerUncontactableException,
                                UserNotAuthorizedException,
                                InvalidParameterException,
                                UnrecognizedGUIDException
```
Fetch complete definition of an glossary given its GUID. The limit and offset paging parameters limit the number elements returned in each of the glossaries relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

Glossary the Glossary entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createGlossary

public Glossary createGlossary(String userId,
                               Glossary glossary)
                        throws MetadataServerUncontactableException,
                               UserNotAuthorizedException,
                               InvalidParameterException,
                               ClassificationException,
                               StatusNotSupportedException

Create new glossary.

Parameters:: userId - user identity; glossary - the input entity with values.
Returns:: Glossary the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateGlossary
```
public Glossary updateGlossary(String userId,
                               Glossary glossary)
                        throws MetadataServerUncontactableException,
                               UserNotAuthorizedException,
                               InvalidParameterException,
                               UnrecognizedGUIDException
```
Update glossary

Parameters:

userId - user identity

glossary - glossary to update

Returns:

Glossary the updated glossary entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteGlossaryByGuid
```
public EntityDetail deleteGlossaryByGuid(String userId,
                                         String entityGuid)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         FunctionNotSupportedException,
                                         InvalidParameterException,
                                         UnrecognizedGUIDException
```
Delete an glossary identified by its GUID. Delete is a soft delete, this means that the glossary has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the glossary

Returns:

Glossary the deleted Glossary entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeGlossaryByGuid
```
public void purgeGlossaryByGuid(String userId,
                                String entityGuid)
                         throws MetadataServerUncontactableException,
                                UserNotAuthorizedException,
                                InvalidParameterException,
                                UnrecognizedGUIDException,
                                EntityNotDeletedException,
                                GUIDNotPurgedException
```
Purge an glossary identified by its GUID. Delete is a hard delete, this means that the glossary is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the glossary

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreGlossary
```
public Glossary restoreGlossary(String userId,
                                String entityGuid)
                         throws MetadataServerUncontactableException,
                                UserNotAuthorizedException,
                                InvalidParameterException,
                                UnrecognizedGUIDException,
                                GUIDNotDeletedException,
                                FunctionNotSupportedException
```
Restore an Glossary identified by its GUID. Restore resurrects a soft deleted Glossary. When a Glossary was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the Glossary

Returns:

Glossary the restored Glossary

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the Glossary is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addGlossaryClassifications

public Glossary addGlossaryClassifications(String userId,
                                           String entityGuid,
                                           List<Classification> classifications)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           InvalidParameterException,
                                           ClassificationException,
                                           UnrecognizedGUIDException

Add classifications to the supplied glossary

Parameters:: userId - user identity; entityGuid - the GUID value for glossary; classifications - the classifications to apply.
Returns:: the glossary entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateGlossaryClassification

public Glossary updateGlossaryClassification(String userId,
                                             String entityGuid,
                                             List<Classification> classificationsToUpdate)
                                      throws MetadataServerUncontactableException,
                                             UserNotAuthorizedException,
                                             InvalidParameterException,
                                             ClassificationException,
                                             UnrecognizedGUIDException

Updates classifications to an existing glossary represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the glossary; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given glossary guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteGlossaryClassification

public Glossary deleteGlossaryClassification(String userId,
                                             String entityGuid,
                                             String name)
                                      throws MetadataServerUncontactableException,
                                             UserNotAuthorizedException,
                                             InvalidParameterException,
                                             ClassificationException,
                                             UnrecognizedGUIDException

Deletes a given classification from an existing glossary represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the glossary; name - name of the classification
Returns:: deleted Glossary classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getGlossaryRelationships
```
public Set<Line> getGlossaryRelationships(String userId,
                                          String entityGuid,
                                          String relationshipTypeGuid,
                                          int fromRelationshipElement,
                                          Date asOfTime,
                                          String sequencingProperty,
                                          SequencingOrder sequencingOrder,
                                          int pageSize)
                                   throws MetadataServerUncontactableException,
                                          UserNotAuthorizedException,
                                          InvalidParameterException,
                                          FunctionNotSupportedException,
                                          UnrecognizedGUIDException
```
Get the relationships associated with entity glossary represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the glossary

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getGlossaryCategoryById
```
public GlossaryCategory getGlossaryCategoryById(String userId,
                                                String entityGuid)
                                         throws MetadataServerUncontactableException,
                                                UserNotAuthorizedException,
                                                InvalidParameterException,
                                                UnrecognizedGUIDException
```
Fetch complete definition of an glossaryCategory given its GUID. The limit and offset paging parameters limit the number elements returned in each of the glossaryCategories relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

GlossaryCategory the GlossaryCategory entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createGlossaryCategory

public GlossaryCategory createGlossaryCategory(String userId,
                                               GlossaryCategory glossaryCategory)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               InvalidParameterException,
                                               ClassificationException,
                                               StatusNotSupportedException

Create new glossaryCategory.

Parameters:: userId - user identity; glossaryCategory - the input entity with values.
Returns:: GlossaryCategory the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateGlossaryCategory

public GlossaryCategory updateGlossaryCategory(String userId,
                                               GlossaryCategory glossaryCategory)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               InvalidParameterException,
                                               UnrecognizedGUIDException

Update glossaryCategory

Parameters:: userId - user identity; glossaryCategory - glossaryCategory to update
Returns:: GlossaryCategory the updated glossaryCategory entity
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteGlossaryCategoryByGuid
```
public EntityDetail deleteGlossaryCategoryByGuid(String userId,
                                                 String entityGuid)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 FunctionNotSupportedException,
                                                 InvalidParameterException,
                                                 UnrecognizedGUIDException
```
Delete an glossaryCategory identified by its GUID. Delete is a soft delete, this means that the glossaryCategory has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the glossaryCategory

Returns:

GlossaryCategory the deleted GlossaryCategory entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeGlossaryCategoryByGuid
```
public void purgeGlossaryCategoryByGuid(String userId,
                                        String entityGuid)
                                 throws MetadataServerUncontactableException,
                                        UserNotAuthorizedException,
                                        InvalidParameterException,
                                        UnrecognizedGUIDException,
                                        EntityNotDeletedException,
                                        GUIDNotPurgedException
```
Purge an glossaryCategory identified by its GUID. Delete is a hard delete, this means that the glossaryCategory is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the glossaryCategory

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreGlossaryCategory
```
public GlossaryCategory restoreGlossaryCategory(String userId,
                                                String entityGuid)
                                         throws MetadataServerUncontactableException,
                                                UserNotAuthorizedException,
                                                InvalidParameterException,
                                                UnrecognizedGUIDException,
                                                GUIDNotDeletedException,
                                                FunctionNotSupportedException
```
Restore an GlossaryCategory identified by its GUID. Restore resurrects a soft deleted GlossaryCategory. When a GlossaryCategory was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the GlossaryCategory

Returns:

GlossaryCategory the restored GlossaryCategory

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the GlossaryCategory is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addGlossaryCategoryClassifications

public GlossaryCategory addGlossaryCategoryClassifications(String userId,
                                                           String entityGuid,
                                                           List<Classification> classifications)
                                                    throws MetadataServerUncontactableException,
                                                           UserNotAuthorizedException,
                                                           InvalidParameterException,
                                                           ClassificationException,
                                                           UnrecognizedGUIDException

Add classifications to the supplied glossaryCategory

Parameters:: userId - user identity; entityGuid - the GUID value for glossaryCategory; classifications - the classifications to apply.
Returns:: the glossaryCategory entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateGlossaryCategoryClassification

public GlossaryCategory updateGlossaryCategoryClassification(String userId,
                                                             String entityGuid,
                                                             List<Classification> classificationsToUpdate)
                                                      throws MetadataServerUncontactableException,
                                                             UserNotAuthorizedException,
                                                             InvalidParameterException,
                                                             ClassificationException,
                                                             UnrecognizedGUIDException

Updates classifications to an existing glossaryCategory represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the glossaryCategory; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given glossaryCategory guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteGlossaryCategoryClassification

public GlossaryCategory deleteGlossaryCategoryClassification(String userId,
                                                             String entityGuid,
                                                             String name)
                                                      throws MetadataServerUncontactableException,
                                                             UserNotAuthorizedException,
                                                             InvalidParameterException,
                                                             ClassificationException,
                                                             UnrecognizedGUIDException

Deletes a given classification from an existing glossaryCategory represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the glossaryCategory; name - name of the classification
Returns:: deleted GlossaryCategory classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getGlossaryCategoryRelationships
```
public Set<Line> getGlossaryCategoryRelationships(String userId,
                                                  String entityGuid,
                                                  String relationshipTypeGuid,
                                                  int fromRelationshipElement,
                                                  Date asOfTime,
                                                  String sequencingProperty,
                                                  SequencingOrder sequencingOrder,
                                                  int pageSize)
                                           throws MetadataServerUncontactableException,
                                                  UserNotAuthorizedException,
                                                  InvalidParameterException,
                                                  FunctionNotSupportedException,
                                                  UnrecognizedGUIDException
```
Get the relationships associated with entity glossaryCategory represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the glossaryCategory

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getMediaCollectionById
```
public MediaCollection getMediaCollectionById(String userId,
                                              String entityGuid)
                                       throws MetadataServerUncontactableException,
                                              UserNotAuthorizedException,
                                              InvalidParameterException,
                                              UnrecognizedGUIDException
```
Fetch complete definition of an mediaCollection given its GUID. The limit and offset paging parameters limit the number elements returned in each of the mediaCollections relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

MediaCollection the MediaCollection entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createMediaCollection

public MediaCollection createMediaCollection(String userId,
                                             MediaCollection mediaCollection)
                                      throws MetadataServerUncontactableException,
                                             UserNotAuthorizedException,
                                             InvalidParameterException,
                                             ClassificationException,
                                             StatusNotSupportedException

Create new mediaCollection.

Parameters:: userId - user identity; mediaCollection - the input entity with values.
Returns:: MediaCollection the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateMediaCollection

public MediaCollection updateMediaCollection(String userId,
                                             MediaCollection mediaCollection)
                                      throws MetadataServerUncontactableException,
                                             UserNotAuthorizedException,
                                             InvalidParameterException,
                                             UnrecognizedGUIDException

Update mediaCollection

Parameters:: userId - user identity; mediaCollection - mediaCollection to update
Returns:: MediaCollection the updated mediaCollection entity
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteMediaCollectionByGuid
```
public EntityDetail deleteMediaCollectionByGuid(String userId,
                                                String entityGuid)
                                         throws MetadataServerUncontactableException,
                                                UserNotAuthorizedException,
                                                FunctionNotSupportedException,
                                                InvalidParameterException,
                                                UnrecognizedGUIDException
```
Delete an mediaCollection identified by its GUID. Delete is a soft delete, this means that the mediaCollection has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the mediaCollection

Returns:

MediaCollection the deleted MediaCollection entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeMediaCollectionByGuid
```
public void purgeMediaCollectionByGuid(String userId,
                                       String entityGuid)
                                throws MetadataServerUncontactableException,
                                       UserNotAuthorizedException,
                                       InvalidParameterException,
                                       UnrecognizedGUIDException,
                                       EntityNotDeletedException,
                                       GUIDNotPurgedException
```
Purge an mediaCollection identified by its GUID. Delete is a hard delete, this means that the mediaCollection is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the mediaCollection

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreMediaCollection
```
public MediaCollection restoreMediaCollection(String userId,
                                              String entityGuid)
                                       throws MetadataServerUncontactableException,
                                              UserNotAuthorizedException,
                                              InvalidParameterException,
                                              UnrecognizedGUIDException,
                                              GUIDNotDeletedException,
                                              FunctionNotSupportedException
```
Restore an MediaCollection identified by its GUID. Restore resurrects a soft deleted MediaCollection. When a MediaCollection was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the MediaCollection

Returns:

MediaCollection the restored MediaCollection

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the MediaCollection is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addMediaCollectionClassifications

public MediaCollection addMediaCollectionClassifications(String userId,
                                                         String entityGuid,
                                                         List<Classification> classifications)
                                                  throws MetadataServerUncontactableException,
                                                         UserNotAuthorizedException,
                                                         InvalidParameterException,
                                                         ClassificationException,
                                                         UnrecognizedGUIDException

Add classifications to the supplied mediaCollection

Parameters:: userId - user identity; entityGuid - the GUID value for mediaCollection; classifications - the classifications to apply.
Returns:: the mediaCollection entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateMediaCollectionClassification

public MediaCollection updateMediaCollectionClassification(String userId,
                                                           String entityGuid,
                                                           List<Classification> classificationsToUpdate)
                                                    throws MetadataServerUncontactableException,
                                                           UserNotAuthorizedException,
                                                           InvalidParameterException,
                                                           ClassificationException,
                                                           UnrecognizedGUIDException

Updates classifications to an existing mediaCollection represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the mediaCollection; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given mediaCollection guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteMediaCollectionClassification

public MediaCollection deleteMediaCollectionClassification(String userId,
                                                           String entityGuid,
                                                           String name)
                                                    throws MetadataServerUncontactableException,
                                                           UserNotAuthorizedException,
                                                           InvalidParameterException,
                                                           ClassificationException,
                                                           UnrecognizedGUIDException

Deletes a given classification from an existing mediaCollection represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the mediaCollection; name - name of the classification
Returns:: deleted MediaCollection classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getMediaCollectionRelationships
```
public Set<Line> getMediaCollectionRelationships(String userId,
                                                 String entityGuid,
                                                 String relationshipTypeGuid,
                                                 int fromRelationshipElement,
                                                 Date asOfTime,
                                                 String sequencingProperty,
                                                 SequencingOrder sequencingOrder,
                                                 int pageSize)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 FunctionNotSupportedException,
                                                 UnrecognizedGUIDException
```
Get the relationships associated with entity mediaCollection represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the mediaCollection

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getCollectionById
```
public Collection getCollectionById(String userId,
                                    String entityGuid)
                             throws MetadataServerUncontactableException,
                                    UserNotAuthorizedException,
                                    InvalidParameterException,
                                    UnrecognizedGUIDException
```
Fetch complete definition of an collection given its GUID. The limit and offset paging parameters limit the number elements returned in each of the collections relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

Collection the Collection entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createCollection

public Collection createCollection(String userId,
                                   Collection collection)
                            throws MetadataServerUncontactableException,
                                   UserNotAuthorizedException,
                                   InvalidParameterException,
                                   ClassificationException,
                                   StatusNotSupportedException

Create new collection.

Parameters:: userId - user identity; collection - the input entity with values.
Returns:: Collection the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateCollection
```
public Collection updateCollection(String userId,
                                   Collection collection)
                            throws MetadataServerUncontactableException,
                                   UserNotAuthorizedException,
                                   InvalidParameterException,
                                   UnrecognizedGUIDException
```
Update collection

Parameters:

userId - user identity

collection - collection to update

Returns:

Collection the updated collection entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteCollectionByGuid
```
public EntityDetail deleteCollectionByGuid(String userId,
                                           String entityGuid)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           FunctionNotSupportedException,
                                           InvalidParameterException,
                                           UnrecognizedGUIDException
```
Delete an collection identified by its GUID. Delete is a soft delete, this means that the collection has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the collection

Returns:

Collection the deleted Collection entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeCollectionByGuid
```
public void purgeCollectionByGuid(String userId,
                                  String entityGuid)
                           throws MetadataServerUncontactableException,
                                  UserNotAuthorizedException,
                                  InvalidParameterException,
                                  UnrecognizedGUIDException,
                                  EntityNotDeletedException,
                                  GUIDNotPurgedException
```
Purge an collection identified by its GUID. Delete is a hard delete, this means that the collection is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the collection

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreCollection
```
public Collection restoreCollection(String userId,
                                    String entityGuid)
                             throws MetadataServerUncontactableException,
                                    UserNotAuthorizedException,
                                    InvalidParameterException,
                                    UnrecognizedGUIDException,
                                    GUIDNotDeletedException,
                                    FunctionNotSupportedException
```
Restore an Collection identified by its GUID. Restore resurrects a soft deleted Collection. When a Collection was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the Collection

Returns:

Collection the restored Collection

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the Collection is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addCollectionClassifications

public Collection addCollectionClassifications(String userId,
                                               String entityGuid,
                                               List<Classification> classifications)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               InvalidParameterException,
                                               ClassificationException,
                                               UnrecognizedGUIDException

Add classifications to the supplied collection

Parameters:: userId - user identity; entityGuid - the GUID value for collection; classifications - the classifications to apply.
Returns:: the collection entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateCollectionClassification

public Collection updateCollectionClassification(String userId,
                                                 String entityGuid,
                                                 List<Classification> classificationsToUpdate)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 ClassificationException,
                                                 UnrecognizedGUIDException

Updates classifications to an existing collection represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the collection; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given collection guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteCollectionClassification

public Collection deleteCollectionClassification(String userId,
                                                 String entityGuid,
                                                 String name)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 ClassificationException,
                                                 UnrecognizedGUIDException

Deletes a given classification from an existing collection represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the collection; name - name of the classification
Returns:: deleted Collection classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getCollectionRelationships
```
public Set<Line> getCollectionRelationships(String userId,
                                            String entityGuid,
                                            String relationshipTypeGuid,
                                            int fromRelationshipElement,
                                            Date asOfTime,
                                            String sequencingProperty,
                                            SequencingOrder sequencingOrder,
                                            int pageSize)
                                     throws MetadataServerUncontactableException,
                                            UserNotAuthorizedException,
                                            InvalidParameterException,
                                            FunctionNotSupportedException,
                                            UnrecognizedGUIDException
```
Get the relationships associated with entity collection represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the collection

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getInformalTagById
```
public InformalTag getInformalTagById(String userId,
                                      String entityGuid)
                               throws MetadataServerUncontactableException,
                                      UserNotAuthorizedException,
                                      InvalidParameterException,
                                      UnrecognizedGUIDException
```
Fetch complete definition of an informalTag given its GUID. The limit and offset paging parameters limit the number elements returned in each of the informalTags relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

InformalTag the InformalTag entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createInformalTag

public InformalTag createInformalTag(String userId,
                                     InformalTag informalTag)
                              throws MetadataServerUncontactableException,
                                     UserNotAuthorizedException,
                                     InvalidParameterException,
                                     ClassificationException,
                                     StatusNotSupportedException

Create new informalTag.

Parameters:: userId - user identity; informalTag - the input entity with values.
Returns:: InformalTag the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateInformalTag
```
public InformalTag updateInformalTag(String userId,
                                     InformalTag informalTag)
                              throws MetadataServerUncontactableException,
                                     UserNotAuthorizedException,
                                     InvalidParameterException,
                                     UnrecognizedGUIDException
```
Update informalTag

Parameters:

userId - user identity

informalTag - informalTag to update

Returns:

InformalTag the updated informalTag entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteInformalTagByGuid
```
public EntityDetail deleteInformalTagByGuid(String userId,
                                            String entityGuid)
                                     throws MetadataServerUncontactableException,
                                            UserNotAuthorizedException,
                                            FunctionNotSupportedException,
                                            InvalidParameterException,
                                            UnrecognizedGUIDException
```
Delete an informalTag identified by its GUID. Delete is a soft delete, this means that the informalTag has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the informalTag

Returns:

InformalTag the deleted InformalTag entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeInformalTagByGuid
```
public void purgeInformalTagByGuid(String userId,
                                   String entityGuid)
                            throws MetadataServerUncontactableException,
                                   UserNotAuthorizedException,
                                   InvalidParameterException,
                                   UnrecognizedGUIDException,
                                   EntityNotDeletedException,
                                   GUIDNotPurgedException
```
Purge an informalTag identified by its GUID. Delete is a hard delete, this means that the informalTag is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the informalTag

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreInformalTag
```
public InformalTag restoreInformalTag(String userId,
                                      String entityGuid)
                               throws MetadataServerUncontactableException,
                                      UserNotAuthorizedException,
                                      InvalidParameterException,
                                      UnrecognizedGUIDException,
                                      GUIDNotDeletedException,
                                      FunctionNotSupportedException
```
Restore an InformalTag identified by its GUID. Restore resurrects a soft deleted InformalTag. When a InformalTag was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the InformalTag

Returns:

InformalTag the restored InformalTag

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the InformalTag is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addInformalTagClassifications

public InformalTag addInformalTagClassifications(String userId,
                                                 String entityGuid,
                                                 List<Classification> classifications)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 ClassificationException,
                                                 UnrecognizedGUIDException

Add classifications to the supplied informalTag

Parameters:: userId - user identity; entityGuid - the GUID value for informalTag; classifications - the classifications to apply.
Returns:: the informalTag entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateInformalTagClassification

public InformalTag updateInformalTagClassification(String userId,
                                                   String entityGuid,
                                                   List<Classification> classificationsToUpdate)
                                            throws MetadataServerUncontactableException,
                                                   UserNotAuthorizedException,
                                                   InvalidParameterException,
                                                   ClassificationException,
                                                   UnrecognizedGUIDException

Updates classifications to an existing informalTag represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the informalTag; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given informalTag guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteInformalTagClassification

public InformalTag deleteInformalTagClassification(String userId,
                                                   String entityGuid,
                                                   String name)
                                            throws MetadataServerUncontactableException,
                                                   UserNotAuthorizedException,
                                                   InvalidParameterException,
                                                   ClassificationException,
                                                   UnrecognizedGUIDException

Deletes a given classification from an existing informalTag represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the informalTag; name - name of the classification
Returns:: deleted InformalTag classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getInformalTagRelationships
```
public Set<Line> getInformalTagRelationships(String userId,
                                             String entityGuid,
                                             String relationshipTypeGuid,
                                             int fromRelationshipElement,
                                             Date asOfTime,
                                             String sequencingProperty,
                                             SequencingOrder sequencingOrder,
                                             int pageSize)
                                      throws MetadataServerUncontactableException,
                                             UserNotAuthorizedException,
                                             InvalidParameterException,
                                             FunctionNotSupportedException,
                                             UnrecognizedGUIDException
```
Get the relationships associated with entity informalTag represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the informalTag

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getGovernanceZoneById
```
public GovernanceZone getGovernanceZoneById(String userId,
                                            String entityGuid)
                                     throws MetadataServerUncontactableException,
                                            UserNotAuthorizedException,
                                            InvalidParameterException,
                                            UnrecognizedGUIDException
```
Fetch complete definition of an governanceZone given its GUID. The limit and offset paging parameters limit the number elements returned in each of the governanceZones relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

GovernanceZone the GovernanceZone entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createGovernanceZone

public GovernanceZone createGovernanceZone(String userId,
                                           GovernanceZone governanceZone)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           InvalidParameterException,
                                           ClassificationException,
                                           StatusNotSupportedException

Create new governanceZone.

Parameters:: userId - user identity; governanceZone - the input entity with values.
Returns:: GovernanceZone the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateGovernanceZone

public GovernanceZone updateGovernanceZone(String userId,
                                           GovernanceZone governanceZone)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           InvalidParameterException,
                                           UnrecognizedGUIDException

Update governanceZone

Parameters:: userId - user identity; governanceZone - governanceZone to update
Returns:: GovernanceZone the updated governanceZone entity
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteGovernanceZoneByGuid
```
public EntityDetail deleteGovernanceZoneByGuid(String userId,
                                               String entityGuid)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               FunctionNotSupportedException,
                                               InvalidParameterException,
                                               UnrecognizedGUIDException
```
Delete an governanceZone identified by its GUID. Delete is a soft delete, this means that the governanceZone has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the governanceZone

Returns:

GovernanceZone the deleted GovernanceZone entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeGovernanceZoneByGuid
```
public void purgeGovernanceZoneByGuid(String userId,
                                      String entityGuid)
                               throws MetadataServerUncontactableException,
                                      UserNotAuthorizedException,
                                      InvalidParameterException,
                                      UnrecognizedGUIDException,
                                      EntityNotDeletedException,
                                      GUIDNotPurgedException
```
Purge an governanceZone identified by its GUID. Delete is a hard delete, this means that the governanceZone is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the governanceZone

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreGovernanceZone
```
public GovernanceZone restoreGovernanceZone(String userId,
                                            String entityGuid)
                                     throws MetadataServerUncontactableException,
                                            UserNotAuthorizedException,
                                            InvalidParameterException,
                                            UnrecognizedGUIDException,
                                            GUIDNotDeletedException,
                                            FunctionNotSupportedException
```
Restore an GovernanceZone identified by its GUID. Restore resurrects a soft deleted GovernanceZone. When a GovernanceZone was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the GovernanceZone

Returns:

GovernanceZone the restored GovernanceZone

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the GovernanceZone is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addGovernanceZoneClassifications

public GovernanceZone addGovernanceZoneClassifications(String userId,
                                                       String entityGuid,
                                                       List<Classification> classifications)
                                                throws MetadataServerUncontactableException,
                                                       UserNotAuthorizedException,
                                                       InvalidParameterException,
                                                       ClassificationException,
                                                       UnrecognizedGUIDException

Add classifications to the supplied governanceZone

Parameters:: userId - user identity; entityGuid - the GUID value for governanceZone; classifications - the classifications to apply.
Returns:: the governanceZone entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateGovernanceZoneClassification

public GovernanceZone updateGovernanceZoneClassification(String userId,
                                                         String entityGuid,
                                                         List<Classification> classificationsToUpdate)
                                                  throws MetadataServerUncontactableException,
                                                         UserNotAuthorizedException,
                                                         InvalidParameterException,
                                                         ClassificationException,
                                                         UnrecognizedGUIDException

Updates classifications to an existing governanceZone represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the governanceZone; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given governanceZone guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteGovernanceZoneClassification

public GovernanceZone deleteGovernanceZoneClassification(String userId,
                                                         String entityGuid,
                                                         String name)
                                                  throws MetadataServerUncontactableException,
                                                         UserNotAuthorizedException,
                                                         InvalidParameterException,
                                                         ClassificationException,
                                                         UnrecognizedGUIDException

Deletes a given classification from an existing governanceZone represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the governanceZone; name - name of the classification
Returns:: deleted GovernanceZone classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getGovernanceZoneRelationships
```
public Set<Line> getGovernanceZoneRelationships(String userId,
                                                String entityGuid,
                                                String relationshipTypeGuid,
                                                int fromRelationshipElement,
                                                Date asOfTime,
                                                String sequencingProperty,
                                                SequencingOrder sequencingOrder,
                                                int pageSize)
                                         throws MetadataServerUncontactableException,
                                                UserNotAuthorizedException,
                                                InvalidParameterException,
                                                FunctionNotSupportedException,
                                                UnrecognizedGUIDException
```
Get the relationships associated with entity governanceZone represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the governanceZone

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getApplicationById
```
public Application getApplicationById(String userId,
                                      String entityGuid)
                               throws MetadataServerUncontactableException,
                                      UserNotAuthorizedException,
                                      InvalidParameterException,
                                      UnrecognizedGUIDException
```
Fetch complete definition of an application given its GUID. The limit and offset paging parameters limit the number elements returned in each of the applications relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

Application the Application entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createApplication

public Application createApplication(String userId,
                                     Application application)
                              throws MetadataServerUncontactableException,
                                     UserNotAuthorizedException,
                                     InvalidParameterException,
                                     ClassificationException,
                                     StatusNotSupportedException

Create new application.

Parameters:: userId - user identity; application - the input entity with values.
Returns:: Application the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateApplication
```
public Application updateApplication(String userId,
                                     Application application)
                              throws MetadataServerUncontactableException,
                                     UserNotAuthorizedException,
                                     InvalidParameterException,
                                     UnrecognizedGUIDException
```
Update application

Parameters:

userId - user identity

application - application to update

Returns:

Application the updated application entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteApplicationByGuid
```
public EntityDetail deleteApplicationByGuid(String userId,
                                            String entityGuid)
                                     throws MetadataServerUncontactableException,
                                            UserNotAuthorizedException,
                                            FunctionNotSupportedException,
                                            InvalidParameterException,
                                            UnrecognizedGUIDException
```
Delete an application identified by its GUID. Delete is a soft delete, this means that the application has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the application

Returns:

Application the deleted Application entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeApplicationByGuid
```
public void purgeApplicationByGuid(String userId,
                                   String entityGuid)
                            throws MetadataServerUncontactableException,
                                   UserNotAuthorizedException,
                                   InvalidParameterException,
                                   UnrecognizedGUIDException,
                                   EntityNotDeletedException,
                                   GUIDNotPurgedException
```
Purge an application identified by its GUID. Delete is a hard delete, this means that the application is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the application

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreApplication
```
public Application restoreApplication(String userId,
                                      String entityGuid)
                               throws MetadataServerUncontactableException,
                                      UserNotAuthorizedException,
                                      InvalidParameterException,
                                      UnrecognizedGUIDException,
                                      GUIDNotDeletedException,
                                      FunctionNotSupportedException
```
Restore an Application identified by its GUID. Restore resurrects a soft deleted Application. When a Application was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the Application

Returns:

Application the restored Application

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the Application is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addApplicationClassifications

public Application addApplicationClassifications(String userId,
                                                 String entityGuid,
                                                 List<Classification> classifications)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 ClassificationException,
                                                 UnrecognizedGUIDException

Add classifications to the supplied application

Parameters:: userId - user identity; entityGuid - the GUID value for application; classifications - the classifications to apply.
Returns:: the application entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateApplicationClassification

public Application updateApplicationClassification(String userId,
                                                   String entityGuid,
                                                   List<Classification> classificationsToUpdate)
                                            throws MetadataServerUncontactableException,
                                                   UserNotAuthorizedException,
                                                   InvalidParameterException,
                                                   ClassificationException,
                                                   UnrecognizedGUIDException

Updates classifications to an existing application represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the application; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given application guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteApplicationClassification

public Application deleteApplicationClassification(String userId,
                                                   String entityGuid,
                                                   String name)
                                            throws MetadataServerUncontactableException,
                                                   UserNotAuthorizedException,
                                                   InvalidParameterException,
                                                   ClassificationException,
                                                   UnrecognizedGUIDException

Deletes a given classification from an existing application represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the application; name - name of the classification
Returns:: deleted Application classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getApplicationRelationships
```
public Set<Line> getApplicationRelationships(String userId,
                                             String entityGuid,
                                             String relationshipTypeGuid,
                                             int fromRelationshipElement,
                                             Date asOfTime,
                                             String sequencingProperty,
                                             SequencingOrder sequencingOrder,
                                             int pageSize)
                                      throws MetadataServerUncontactableException,
                                             UserNotAuthorizedException,
                                             InvalidParameterException,
                                             FunctionNotSupportedException,
                                             UnrecognizedGUIDException
```
Get the relationships associated with entity application represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the application

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getPersonById
```
public Person getPersonById(String userId,
                            String entityGuid)
                     throws MetadataServerUncontactableException,
                            UserNotAuthorizedException,
                            InvalidParameterException,
                            UnrecognizedGUIDException
```
Fetch complete definition of an person given its GUID. The limit and offset paging parameters limit the number elements returned in each of the persons relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

Person the Person entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createPerson
```
public Person createPerson(String userId,
                           Person person)
                    throws MetadataServerUncontactableException,
                           UserNotAuthorizedException,
                           InvalidParameterException,
                           ClassificationException,
                           StatusNotSupportedException
```
Create new person.

Parameters:

userId - user identity

person - the input entity with values.

Returns:

Person the created entity.

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

ClassificationException - a classification does not match constraints.

StatusNotSupportedException - status is not supported

updatePerson
```
public Person updatePerson(String userId,
                           Person person)
                    throws MetadataServerUncontactableException,
                           UserNotAuthorizedException,
                           InvalidParameterException,
                           UnrecognizedGUIDException
```
Update person

Parameters:

userId - user identity

person - person to update

Returns:

Person the updated person entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deletePersonByGuid
```
public EntityDetail deletePersonByGuid(String userId,
                                       String entityGuid)
                                throws MetadataServerUncontactableException,
                                       UserNotAuthorizedException,
                                       FunctionNotSupportedException,
                                       InvalidParameterException,
                                       UnrecognizedGUIDException
```
Delete an person identified by its GUID. Delete is a soft delete, this means that the person has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the person

Returns:

Person the deleted Person entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgePersonByGuid
```
public void purgePersonByGuid(String userId,
                              String entityGuid)
                       throws MetadataServerUncontactableException,
                              UserNotAuthorizedException,
                              InvalidParameterException,
                              UnrecognizedGUIDException,
                              EntityNotDeletedException,
                              GUIDNotPurgedException
```
Purge an person identified by its GUID. Delete is a hard delete, this means that the person is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the person

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restorePerson
```
public Person restorePerson(String userId,
                            String entityGuid)
                     throws MetadataServerUncontactableException,
                            UserNotAuthorizedException,
                            InvalidParameterException,
                            UnrecognizedGUIDException,
                            GUIDNotDeletedException,
                            FunctionNotSupportedException
```
Restore an Person identified by its GUID. Restore resurrects a soft deleted Person. When a Person was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the Person

Returns:

Person the restored Person

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the Person is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addPersonClassifications

public Person addPersonClassifications(String userId,
                                       String entityGuid,
                                       List<Classification> classifications)
                                throws MetadataServerUncontactableException,
                                       UserNotAuthorizedException,
                                       InvalidParameterException,
                                       ClassificationException,
                                       UnrecognizedGUIDException

Add classifications to the supplied person

Parameters:: userId - user identity; entityGuid - the GUID value for person; classifications - the classifications to apply.
Returns:: the person entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updatePersonClassification

public Person updatePersonClassification(String userId,
                                         String entityGuid,
                                         List<Classification> classificationsToUpdate)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         InvalidParameterException,
                                         ClassificationException,
                                         UnrecognizedGUIDException

Updates classifications to an existing person represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the person; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given person guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deletePersonClassification

public Person deletePersonClassification(String userId,
                                         String entityGuid,
                                         String name)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         InvalidParameterException,
                                         ClassificationException,
                                         UnrecognizedGUIDException

Deletes a given classification from an existing person represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the person; name - name of the classification
Returns:: deleted Person classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getPersonRelationships
```
public Set<Line> getPersonRelationships(String userId,
                                        String entityGuid,
                                        String relationshipTypeGuid,
                                        int fromRelationshipElement,
                                        Date asOfTime,
                                        String sequencingProperty,
                                        SequencingOrder sequencingOrder,
                                        int pageSize)
                                 throws MetadataServerUncontactableException,
                                        UserNotAuthorizedException,
                                        InvalidParameterException,
                                        FunctionNotSupportedException,
                                        UnrecognizedGUIDException
```
Get the relationships associated with entity person represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the person

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getVirtualContainerById
```
public VirtualContainer getVirtualContainerById(String userId,
                                                String entityGuid)
                                         throws MetadataServerUncontactableException,
                                                UserNotAuthorizedException,
                                                InvalidParameterException,
                                                UnrecognizedGUIDException
```
Fetch complete definition of an virtualContainer given its GUID. The limit and offset paging parameters limit the number elements returned in each of the virtualContainers relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

VirtualContainer the VirtualContainer entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createVirtualContainer

public VirtualContainer createVirtualContainer(String userId,
                                               VirtualContainer virtualContainer)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               InvalidParameterException,
                                               ClassificationException,
                                               StatusNotSupportedException

Create new virtualContainer.

Parameters:: userId - user identity; virtualContainer - the input entity with values.
Returns:: VirtualContainer the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateVirtualContainer

public VirtualContainer updateVirtualContainer(String userId,
                                               VirtualContainer virtualContainer)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               InvalidParameterException,
                                               UnrecognizedGUIDException

Update virtualContainer

Parameters:: userId - user identity; virtualContainer - virtualContainer to update
Returns:: VirtualContainer the updated virtualContainer entity
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteVirtualContainerByGuid
```
public EntityDetail deleteVirtualContainerByGuid(String userId,
                                                 String entityGuid)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 FunctionNotSupportedException,
                                                 InvalidParameterException,
                                                 UnrecognizedGUIDException
```
Delete an virtualContainer identified by its GUID. Delete is a soft delete, this means that the virtualContainer has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the virtualContainer

Returns:

VirtualContainer the deleted VirtualContainer entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeVirtualContainerByGuid
```
public void purgeVirtualContainerByGuid(String userId,
                                        String entityGuid)
                                 throws MetadataServerUncontactableException,
                                        UserNotAuthorizedException,
                                        InvalidParameterException,
                                        UnrecognizedGUIDException,
                                        EntityNotDeletedException,
                                        GUIDNotPurgedException
```
Purge an virtualContainer identified by its GUID. Delete is a hard delete, this means that the virtualContainer is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the virtualContainer

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreVirtualContainer
```
public VirtualContainer restoreVirtualContainer(String userId,
                                                String entityGuid)
                                         throws MetadataServerUncontactableException,
                                                UserNotAuthorizedException,
                                                InvalidParameterException,
                                                UnrecognizedGUIDException,
                                                GUIDNotDeletedException,
                                                FunctionNotSupportedException
```
Restore an VirtualContainer identified by its GUID. Restore resurrects a soft deleted VirtualContainer. When a VirtualContainer was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the VirtualContainer

Returns:

VirtualContainer the restored VirtualContainer

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the VirtualContainer is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addVirtualContainerClassifications

public VirtualContainer addVirtualContainerClassifications(String userId,
                                                           String entityGuid,
                                                           List<Classification> classifications)
                                                    throws MetadataServerUncontactableException,
                                                           UserNotAuthorizedException,
                                                           InvalidParameterException,
                                                           ClassificationException,
                                                           UnrecognizedGUIDException

Add classifications to the supplied virtualContainer

Parameters:: userId - user identity; entityGuid - the GUID value for virtualContainer; classifications - the classifications to apply.
Returns:: the virtualContainer entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateVirtualContainerClassification

public VirtualContainer updateVirtualContainerClassification(String userId,
                                                             String entityGuid,
                                                             List<Classification> classificationsToUpdate)
                                                      throws MetadataServerUncontactableException,
                                                             UserNotAuthorizedException,
                                                             InvalidParameterException,
                                                             ClassificationException,
                                                             UnrecognizedGUIDException

Updates classifications to an existing virtualContainer represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the virtualContainer; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given virtualContainer guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteVirtualContainerClassification

public VirtualContainer deleteVirtualContainerClassification(String userId,
                                                             String entityGuid,
                                                             String name)
                                                      throws MetadataServerUncontactableException,
                                                             UserNotAuthorizedException,
                                                             InvalidParameterException,
                                                             ClassificationException,
                                                             UnrecognizedGUIDException

Deletes a given classification from an existing virtualContainer represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the virtualContainer; name - name of the classification
Returns:: deleted VirtualContainer classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getVirtualContainerRelationships
```
public Set<Line> getVirtualContainerRelationships(String userId,
                                                  String entityGuid,
                                                  String relationshipTypeGuid,
                                                  int fromRelationshipElement,
                                                  Date asOfTime,
                                                  String sequencingProperty,
                                                  SequencingOrder sequencingOrder,
                                                  int pageSize)
                                           throws MetadataServerUncontactableException,
                                                  UserNotAuthorizedException,
                                                  InvalidParameterException,
                                                  FunctionNotSupportedException,
                                                  UnrecognizedGUIDException
```
Get the relationships associated with entity virtualContainer represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the virtualContainer

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getGovernanceDriverById
```
public GovernanceDriver getGovernanceDriverById(String userId,
                                                String entityGuid)
                                         throws MetadataServerUncontactableException,
                                                UserNotAuthorizedException,
                                                InvalidParameterException,
                                                UnrecognizedGUIDException
```
Fetch complete definition of an governanceDriver given its GUID. The limit and offset paging parameters limit the number elements returned in each of the governanceDrivers relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

GovernanceDriver the GovernanceDriver entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createGovernanceDriver

public GovernanceDriver createGovernanceDriver(String userId,
                                               GovernanceDriver governanceDriver)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               InvalidParameterException,
                                               ClassificationException,
                                               StatusNotSupportedException

Create new governanceDriver.

Parameters:: userId - user identity; governanceDriver - the input entity with values.
Returns:: GovernanceDriver the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateGovernanceDriver

public GovernanceDriver updateGovernanceDriver(String userId,
                                               GovernanceDriver governanceDriver)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               InvalidParameterException,
                                               UnrecognizedGUIDException

Update governanceDriver

Parameters:: userId - user identity; governanceDriver - governanceDriver to update
Returns:: GovernanceDriver the updated governanceDriver entity
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteGovernanceDriverByGuid
```
public EntityDetail deleteGovernanceDriverByGuid(String userId,
                                                 String entityGuid)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 FunctionNotSupportedException,
                                                 InvalidParameterException,
                                                 UnrecognizedGUIDException
```
Delete an governanceDriver identified by its GUID. Delete is a soft delete, this means that the governanceDriver has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the governanceDriver

Returns:

GovernanceDriver the deleted GovernanceDriver entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeGovernanceDriverByGuid
```
public void purgeGovernanceDriverByGuid(String userId,
                                        String entityGuid)
                                 throws MetadataServerUncontactableException,
                                        UserNotAuthorizedException,
                                        InvalidParameterException,
                                        UnrecognizedGUIDException,
                                        EntityNotDeletedException,
                                        GUIDNotPurgedException
```
Purge an governanceDriver identified by its GUID. Delete is a hard delete, this means that the governanceDriver is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the governanceDriver

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreGovernanceDriver
```
public GovernanceDriver restoreGovernanceDriver(String userId,
                                                String entityGuid)
                                         throws MetadataServerUncontactableException,
                                                UserNotAuthorizedException,
                                                InvalidParameterException,
                                                UnrecognizedGUIDException,
                                                GUIDNotDeletedException,
                                                FunctionNotSupportedException
```
Restore an GovernanceDriver identified by its GUID. Restore resurrects a soft deleted GovernanceDriver. When a GovernanceDriver was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the GovernanceDriver

Returns:

GovernanceDriver the restored GovernanceDriver

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the GovernanceDriver is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addGovernanceDriverClassifications

public GovernanceDriver addGovernanceDriverClassifications(String userId,
                                                           String entityGuid,
                                                           List<Classification> classifications)
                                                    throws MetadataServerUncontactableException,
                                                           UserNotAuthorizedException,
                                                           InvalidParameterException,
                                                           ClassificationException,
                                                           UnrecognizedGUIDException

Add classifications to the supplied governanceDriver

Parameters:: userId - user identity; entityGuid - the GUID value for governanceDriver; classifications - the classifications to apply.
Returns:: the governanceDriver entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateGovernanceDriverClassification

public GovernanceDriver updateGovernanceDriverClassification(String userId,
                                                             String entityGuid,
                                                             List<Classification> classificationsToUpdate)
                                                      throws MetadataServerUncontactableException,
                                                             UserNotAuthorizedException,
                                                             InvalidParameterException,
                                                             ClassificationException,
                                                             UnrecognizedGUIDException

Updates classifications to an existing governanceDriver represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the governanceDriver; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given governanceDriver guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteGovernanceDriverClassification

public GovernanceDriver deleteGovernanceDriverClassification(String userId,
                                                             String entityGuid,
                                                             String name)
                                                      throws MetadataServerUncontactableException,
                                                             UserNotAuthorizedException,
                                                             InvalidParameterException,
                                                             ClassificationException,
                                                             UnrecognizedGUIDException

Deletes a given classification from an existing governanceDriver represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the governanceDriver; name - name of the classification
Returns:: deleted GovernanceDriver classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getGovernanceDriverRelationships
```
public Set<Line> getGovernanceDriverRelationships(String userId,
                                                  String entityGuid,
                                                  String relationshipTypeGuid,
                                                  int fromRelationshipElement,
                                                  Date asOfTime,
                                                  String sequencingProperty,
                                                  SequencingOrder sequencingOrder,
                                                  int pageSize)
                                           throws MetadataServerUncontactableException,
                                                  UserNotAuthorizedException,
                                                  InvalidParameterException,
                                                  FunctionNotSupportedException,
                                                  UnrecognizedGUIDException
```
Get the relationships associated with entity governanceDriver represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the governanceDriver

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getMeetingById
```
public Meeting getMeetingById(String userId,
                              String entityGuid)
                       throws MetadataServerUncontactableException,
                              UserNotAuthorizedException,
                              InvalidParameterException,
                              UnrecognizedGUIDException
```
Fetch complete definition of an meeting given its GUID. The limit and offset paging parameters limit the number elements returned in each of the meetings relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

Meeting the Meeting entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createMeeting

public Meeting createMeeting(String userId,
                             Meeting meeting)
                      throws MetadataServerUncontactableException,
                             UserNotAuthorizedException,
                             InvalidParameterException,
                             ClassificationException,
                             StatusNotSupportedException

Create new meeting.

Parameters:: userId - user identity; meeting - the input entity with values.
Returns:: Meeting the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateMeeting
```
public Meeting updateMeeting(String userId,
                             Meeting meeting)
                      throws MetadataServerUncontactableException,
                             UserNotAuthorizedException,
                             InvalidParameterException,
                             UnrecognizedGUIDException
```
Update meeting

Parameters:

userId - user identity

meeting - meeting to update

Returns:

Meeting the updated meeting entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteMeetingByGuid
```
public EntityDetail deleteMeetingByGuid(String userId,
                                        String entityGuid)
                                 throws MetadataServerUncontactableException,
                                        UserNotAuthorizedException,
                                        FunctionNotSupportedException,
                                        InvalidParameterException,
                                        UnrecognizedGUIDException
```
Delete an meeting identified by its GUID. Delete is a soft delete, this means that the meeting has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the meeting

Returns:

Meeting the deleted Meeting entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeMeetingByGuid
```
public void purgeMeetingByGuid(String userId,
                               String entityGuid)
                        throws MetadataServerUncontactableException,
                               UserNotAuthorizedException,
                               InvalidParameterException,
                               UnrecognizedGUIDException,
                               EntityNotDeletedException,
                               GUIDNotPurgedException
```
Purge an meeting identified by its GUID. Delete is a hard delete, this means that the meeting is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the meeting

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreMeeting
```
public Meeting restoreMeeting(String userId,
                              String entityGuid)
                       throws MetadataServerUncontactableException,
                              UserNotAuthorizedException,
                              InvalidParameterException,
                              UnrecognizedGUIDException,
                              GUIDNotDeletedException,
                              FunctionNotSupportedException
```
Restore an Meeting identified by its GUID. Restore resurrects a soft deleted Meeting. When a Meeting was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the Meeting

Returns:

Meeting the restored Meeting

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the Meeting is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addMeetingClassifications

public Meeting addMeetingClassifications(String userId,
                                         String entityGuid,
                                         List<Classification> classifications)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         InvalidParameterException,
                                         ClassificationException,
                                         UnrecognizedGUIDException

Add classifications to the supplied meeting

Parameters:: userId - user identity; entityGuid - the GUID value for meeting; classifications - the classifications to apply.
Returns:: the meeting entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateMeetingClassification

public Meeting updateMeetingClassification(String userId,
                                           String entityGuid,
                                           List<Classification> classificationsToUpdate)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           InvalidParameterException,
                                           ClassificationException,
                                           UnrecognizedGUIDException

Updates classifications to an existing meeting represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the meeting; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given meeting guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteMeetingClassification

public Meeting deleteMeetingClassification(String userId,
                                           String entityGuid,
                                           String name)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           InvalidParameterException,
                                           ClassificationException,
                                           UnrecognizedGUIDException

Deletes a given classification from an existing meeting represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the meeting; name - name of the classification
Returns:: deleted Meeting classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getMeetingRelationships
```
public Set<Line> getMeetingRelationships(String userId,
                                         String entityGuid,
                                         String relationshipTypeGuid,
                                         int fromRelationshipElement,
                                         Date asOfTime,
                                         String sequencingProperty,
                                         SequencingOrder sequencingOrder,
                                         int pageSize)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         InvalidParameterException,
                                         FunctionNotSupportedException,
                                         UnrecognizedGUIDException
```
Get the relationships associated with entity meeting represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the meeting

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getSoftwareServerPlatformById
```
public SoftwareServerPlatform getSoftwareServerPlatformById(String userId,
                                                            String entityGuid)
                                                     throws MetadataServerUncontactableException,
                                                            UserNotAuthorizedException,
                                                            InvalidParameterException,
                                                            UnrecognizedGUIDException
```
Fetch complete definition of an softwareServerPlatform given its GUID. The limit and offset paging parameters limit the number elements returned in each of the softwareServerPlatforms relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

SoftwareServerPlatform the SoftwareServerPlatform entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createSoftwareServerPlatform

public SoftwareServerPlatform createSoftwareServerPlatform(String userId,
                                                           SoftwareServerPlatform softwareServerPlatform)
                                                    throws MetadataServerUncontactableException,
                                                           UserNotAuthorizedException,
                                                           InvalidParameterException,
                                                           ClassificationException,
                                                           StatusNotSupportedException

Create new softwareServerPlatform.

Parameters:: userId - user identity; softwareServerPlatform - the input entity with values.
Returns:: SoftwareServerPlatform the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateSoftwareServerPlatform

public SoftwareServerPlatform updateSoftwareServerPlatform(String userId,
                                                           SoftwareServerPlatform softwareServerPlatform)
                                                    throws MetadataServerUncontactableException,
                                                           UserNotAuthorizedException,
                                                           InvalidParameterException,
                                                           UnrecognizedGUIDException

Update softwareServerPlatform

Parameters:: userId - user identity; softwareServerPlatform - softwareServerPlatform to update
Returns:: SoftwareServerPlatform the updated softwareServerPlatform entity
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteSoftwareServerPlatformByGuid
```
public EntityDetail deleteSoftwareServerPlatformByGuid(String userId,
                                                       String entityGuid)
                                                throws MetadataServerUncontactableException,
                                                       UserNotAuthorizedException,
                                                       FunctionNotSupportedException,
                                                       InvalidParameterException,
                                                       UnrecognizedGUIDException
```
Delete an softwareServerPlatform identified by its GUID. Delete is a soft delete, this means that the softwareServerPlatform has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the softwareServerPlatform

Returns:

SoftwareServerPlatform the deleted SoftwareServerPlatform entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeSoftwareServerPlatformByGuid

public void purgeSoftwareServerPlatformByGuid(String userId,
                                              String entityGuid)
                                       throws MetadataServerUncontactableException,
                                              UserNotAuthorizedException,
                                              InvalidParameterException,
                                              UnrecognizedGUIDException,
                                              EntityNotDeletedException,
                                              GUIDNotPurgedException

Purge an softwareServerPlatform identified by its GUID. Delete is a hard delete, this means that the softwareServerPlatform is really deleted .

Parameters:: userId - user identity; entityGuid - GUID for the softwareServerPlatform
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; EntityNotDeletedException - the entity was not deleted; GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreSoftwareServerPlatform

public SoftwareServerPlatform restoreSoftwareServerPlatform(String userId,
                                                            String entityGuid)
                                                     throws MetadataServerUncontactableException,
                                                            UserNotAuthorizedException,
                                                            InvalidParameterException,
                                                            UnrecognizedGUIDException,
                                                            GUIDNotDeletedException,
                                                            FunctionNotSupportedException

Restore an SoftwareServerPlatform identified by its GUID. Restore resurrects a soft deleted SoftwareServerPlatform. When a SoftwareServerPlatform was incorrectly deleted, the delete can be undone using the restore..

Parameters:: userId - user identity; entityGuid - GUID for the SoftwareServerPlatform
Returns:: SoftwareServerPlatform the restored SoftwareServerPlatform
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; GUIDNotDeletedException - the guid of the SoftwareServerPlatform is not deleted, so cannot be restored; FunctionNotSupportedException - Function not supported

addSoftwareServerPlatformClassifications

public SoftwareServerPlatform addSoftwareServerPlatformClassifications(String userId,
                                                                       String entityGuid,
                                                                       List<Classification> classifications)
                                                                throws MetadataServerUncontactableException,
                                                                       UserNotAuthorizedException,
                                                                       InvalidParameterException,
                                                                       ClassificationException,
                                                                       UnrecognizedGUIDException

Add classifications to the supplied softwareServerPlatform

Parameters:: userId - user identity; entityGuid - the GUID value for softwareServerPlatform; classifications - the classifications to apply.
Returns:: the softwareServerPlatform entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateSoftwareServerPlatformClassification

public SoftwareServerPlatform updateSoftwareServerPlatformClassification(String userId,
                                                                         String entityGuid,
                                                                         List<Classification> classificationsToUpdate)
                                                                  throws MetadataServerUncontactableException,
                                                                         UserNotAuthorizedException,
                                                                         InvalidParameterException,
                                                                         ClassificationException,
                                                                         UnrecognizedGUIDException

Updates classifications to an existing softwareServerPlatform represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the softwareServerPlatform; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given softwareServerPlatform guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteSoftwareServerPlatformClassification

public SoftwareServerPlatform deleteSoftwareServerPlatformClassification(String userId,
                                                                         String entityGuid,
                                                                         String name)
                                                                  throws MetadataServerUncontactableException,
                                                                         UserNotAuthorizedException,
                                                                         InvalidParameterException,
                                                                         ClassificationException,
                                                                         UnrecognizedGUIDException

Deletes a given classification from an existing softwareServerPlatform represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the softwareServerPlatform; name - name of the classification
Returns:: deleted SoftwareServerPlatform classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getSoftwareServerPlatformRelationships
```
public Set<Line> getSoftwareServerPlatformRelationships(String userId,
                                                        String entityGuid,
                                                        String relationshipTypeGuid,
                                                        int fromRelationshipElement,
                                                        Date asOfTime,
                                                        String sequencingProperty,
                                                        SequencingOrder sequencingOrder,
                                                        int pageSize)
                                                 throws MetadataServerUncontactableException,
                                                        UserNotAuthorizedException,
                                                        InvalidParameterException,
                                                        FunctionNotSupportedException,
                                                        UnrecognizedGUIDException
```
Get the relationships associated with entity softwareServerPlatform represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the softwareServerPlatform

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getRatingById
```
public Rating getRatingById(String userId,
                            String entityGuid)
                     throws MetadataServerUncontactableException,
                            UserNotAuthorizedException,
                            InvalidParameterException,
                            UnrecognizedGUIDException
```
Fetch complete definition of an rating given its GUID. The limit and offset paging parameters limit the number elements returned in each of the ratings relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

Rating the Rating entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createRating
```
public Rating createRating(String userId,
                           Rating rating)
                    throws MetadataServerUncontactableException,
                           UserNotAuthorizedException,
                           InvalidParameterException,
                           ClassificationException,
                           StatusNotSupportedException
```
Create new rating.

Parameters:

userId - user identity

rating - the input entity with values.

Returns:

Rating the created entity.

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

ClassificationException - a classification does not match constraints.

StatusNotSupportedException - status is not supported

updateRating
```
public Rating updateRating(String userId,
                           Rating rating)
                    throws MetadataServerUncontactableException,
                           UserNotAuthorizedException,
                           InvalidParameterException,
                           UnrecognizedGUIDException
```
Update rating

Parameters:

userId - user identity

rating - rating to update

Returns:

Rating the updated rating entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteRatingByGuid
```
public EntityDetail deleteRatingByGuid(String userId,
                                       String entityGuid)
                                throws MetadataServerUncontactableException,
                                       UserNotAuthorizedException,
                                       FunctionNotSupportedException,
                                       InvalidParameterException,
                                       UnrecognizedGUIDException
```
Delete an rating identified by its GUID. Delete is a soft delete, this means that the rating has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the rating

Returns:

Rating the deleted Rating entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeRatingByGuid
```
public void purgeRatingByGuid(String userId,
                              String entityGuid)
                       throws MetadataServerUncontactableException,
                              UserNotAuthorizedException,
                              InvalidParameterException,
                              UnrecognizedGUIDException,
                              EntityNotDeletedException,
                              GUIDNotPurgedException
```
Purge an rating identified by its GUID. Delete is a hard delete, this means that the rating is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the rating

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreRating
```
public Rating restoreRating(String userId,
                            String entityGuid)
                     throws MetadataServerUncontactableException,
                            UserNotAuthorizedException,
                            InvalidParameterException,
                            UnrecognizedGUIDException,
                            GUIDNotDeletedException,
                            FunctionNotSupportedException
```
Restore an Rating identified by its GUID. Restore resurrects a soft deleted Rating. When a Rating was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the Rating

Returns:

Rating the restored Rating

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the Rating is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addRatingClassifications

public Rating addRatingClassifications(String userId,
                                       String entityGuid,
                                       List<Classification> classifications)
                                throws MetadataServerUncontactableException,
                                       UserNotAuthorizedException,
                                       InvalidParameterException,
                                       ClassificationException,
                                       UnrecognizedGUIDException

Add classifications to the supplied rating

Parameters:: userId - user identity; entityGuid - the GUID value for rating; classifications - the classifications to apply.
Returns:: the rating entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateRatingClassification

public Rating updateRatingClassification(String userId,
                                         String entityGuid,
                                         List<Classification> classificationsToUpdate)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         InvalidParameterException,
                                         ClassificationException,
                                         UnrecognizedGUIDException

Updates classifications to an existing rating represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the rating; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given rating guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteRatingClassification

public Rating deleteRatingClassification(String userId,
                                         String entityGuid,
                                         String name)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         InvalidParameterException,
                                         ClassificationException,
                                         UnrecognizedGUIDException

Deletes a given classification from an existing rating represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the rating; name - name of the classification
Returns:: deleted Rating classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getRatingRelationships
```
public Set<Line> getRatingRelationships(String userId,
                                        String entityGuid,
                                        String relationshipTypeGuid,
                                        int fromRelationshipElement,
                                        Date asOfTime,
                                        String sequencingProperty,
                                        SequencingOrder sequencingOrder,
                                        int pageSize)
                                 throws MetadataServerUncontactableException,
                                        UserNotAuthorizedException,
                                        InvalidParameterException,
                                        FunctionNotSupportedException,
                                        UnrecognizedGUIDException
```
Get the relationships associated with entity rating represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the rating

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getProjectCharterById
```
public ProjectCharter getProjectCharterById(String userId,
                                            String entityGuid)
                                     throws MetadataServerUncontactableException,
                                            UserNotAuthorizedException,
                                            InvalidParameterException,
                                            UnrecognizedGUIDException
```
Fetch complete definition of an projectCharter given its GUID. The limit and offset paging parameters limit the number elements returned in each of the projectCharters relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

ProjectCharter the ProjectCharter entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createProjectCharter

public ProjectCharter createProjectCharter(String userId,
                                           ProjectCharter projectCharter)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           InvalidParameterException,
                                           ClassificationException,
                                           StatusNotSupportedException

Create new projectCharter.

Parameters:: userId - user identity; projectCharter - the input entity with values.
Returns:: ProjectCharter the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateProjectCharter

public ProjectCharter updateProjectCharter(String userId,
                                           ProjectCharter projectCharter)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           InvalidParameterException,
                                           UnrecognizedGUIDException

Update projectCharter

Parameters:: userId - user identity; projectCharter - projectCharter to update
Returns:: ProjectCharter the updated projectCharter entity
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteProjectCharterByGuid
```
public EntityDetail deleteProjectCharterByGuid(String userId,
                                               String entityGuid)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               FunctionNotSupportedException,
                                               InvalidParameterException,
                                               UnrecognizedGUIDException
```
Delete an projectCharter identified by its GUID. Delete is a soft delete, this means that the projectCharter has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the projectCharter

Returns:

ProjectCharter the deleted ProjectCharter entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeProjectCharterByGuid
```
public void purgeProjectCharterByGuid(String userId,
                                      String entityGuid)
                               throws MetadataServerUncontactableException,
                                      UserNotAuthorizedException,
                                      InvalidParameterException,
                                      UnrecognizedGUIDException,
                                      EntityNotDeletedException,
                                      GUIDNotPurgedException
```
Purge an projectCharter identified by its GUID. Delete is a hard delete, this means that the projectCharter is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the projectCharter

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreProjectCharter
```
public ProjectCharter restoreProjectCharter(String userId,
                                            String entityGuid)
                                     throws MetadataServerUncontactableException,
                                            UserNotAuthorizedException,
                                            InvalidParameterException,
                                            UnrecognizedGUIDException,
                                            GUIDNotDeletedException,
                                            FunctionNotSupportedException
```
Restore an ProjectCharter identified by its GUID. Restore resurrects a soft deleted ProjectCharter. When a ProjectCharter was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the ProjectCharter

Returns:

ProjectCharter the restored ProjectCharter

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the ProjectCharter is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addProjectCharterClassifications

public ProjectCharter addProjectCharterClassifications(String userId,
                                                       String entityGuid,
                                                       List<Classification> classifications)
                                                throws MetadataServerUncontactableException,
                                                       UserNotAuthorizedException,
                                                       InvalidParameterException,
                                                       ClassificationException,
                                                       UnrecognizedGUIDException

Add classifications to the supplied projectCharter

Parameters:: userId - user identity; entityGuid - the GUID value for projectCharter; classifications - the classifications to apply.
Returns:: the projectCharter entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateProjectCharterClassification

public ProjectCharter updateProjectCharterClassification(String userId,
                                                         String entityGuid,
                                                         List<Classification> classificationsToUpdate)
                                                  throws MetadataServerUncontactableException,
                                                         UserNotAuthorizedException,
                                                         InvalidParameterException,
                                                         ClassificationException,
                                                         UnrecognizedGUIDException

Updates classifications to an existing projectCharter represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the projectCharter; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given projectCharter guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteProjectCharterClassification

public ProjectCharter deleteProjectCharterClassification(String userId,
                                                         String entityGuid,
                                                         String name)
                                                  throws MetadataServerUncontactableException,
                                                         UserNotAuthorizedException,
                                                         InvalidParameterException,
                                                         ClassificationException,
                                                         UnrecognizedGUIDException

Deletes a given classification from an existing projectCharter represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the projectCharter; name - name of the classification
Returns:: deleted ProjectCharter classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getProjectCharterRelationships
```
public Set<Line> getProjectCharterRelationships(String userId,
                                                String entityGuid,
                                                String relationshipTypeGuid,
                                                int fromRelationshipElement,
                                                Date asOfTime,
                                                String sequencingProperty,
                                                SequencingOrder sequencingOrder,
                                                int pageSize)
                                         throws MetadataServerUncontactableException,
                                                UserNotAuthorizedException,
                                                InvalidParameterException,
                                                FunctionNotSupportedException,
                                                UnrecognizedGUIDException
```
Get the relationships associated with entity projectCharter represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the projectCharter

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getSoftwareServerCapabilityById
```
public SoftwareServerCapability getSoftwareServerCapabilityById(String userId,
                                                                String entityGuid)
                                                         throws MetadataServerUncontactableException,
                                                                UserNotAuthorizedException,
                                                                InvalidParameterException,
                                                                UnrecognizedGUIDException
```
Fetch complete definition of an softwareServerCapability given its GUID. The limit and offset paging parameters limit the number elements returned in each of the softwareServerCapabilities relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

SoftwareServerCapability the SoftwareServerCapability entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createSoftwareServerCapability

public SoftwareServerCapability createSoftwareServerCapability(String userId,
                                                               SoftwareServerCapability softwareServerCapability)
                                                        throws MetadataServerUncontactableException,
                                                               UserNotAuthorizedException,
                                                               InvalidParameterException,
                                                               ClassificationException,
                                                               StatusNotSupportedException

Create new softwareServerCapability.

Parameters:: userId - user identity; softwareServerCapability - the input entity with values.
Returns:: SoftwareServerCapability the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateSoftwareServerCapability

public SoftwareServerCapability updateSoftwareServerCapability(String userId,
                                                               SoftwareServerCapability softwareServerCapability)
                                                        throws MetadataServerUncontactableException,
                                                               UserNotAuthorizedException,
                                                               InvalidParameterException,
                                                               UnrecognizedGUIDException

Update softwareServerCapability

Parameters:: userId - user identity; softwareServerCapability - softwareServerCapability to update
Returns:: SoftwareServerCapability the updated softwareServerCapability entity
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteSoftwareServerCapabilityByGuid
```
public EntityDetail deleteSoftwareServerCapabilityByGuid(String userId,
                                                         String entityGuid)
                                                  throws MetadataServerUncontactableException,
                                                         UserNotAuthorizedException,
                                                         FunctionNotSupportedException,
                                                         InvalidParameterException,
                                                         UnrecognizedGUIDException
```
Delete an softwareServerCapability identified by its GUID. Delete is a soft delete, this means that the softwareServerCapability has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the softwareServerCapability

Returns:

SoftwareServerCapability the deleted SoftwareServerCapability entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeSoftwareServerCapabilityByGuid

public void purgeSoftwareServerCapabilityByGuid(String userId,
                                                String entityGuid)
                                         throws MetadataServerUncontactableException,
                                                UserNotAuthorizedException,
                                                InvalidParameterException,
                                                UnrecognizedGUIDException,
                                                EntityNotDeletedException,
                                                GUIDNotPurgedException

Purge an softwareServerCapability identified by its GUID. Delete is a hard delete, this means that the softwareServerCapability is really deleted .

Parameters:: userId - user identity; entityGuid - GUID for the softwareServerCapability
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; EntityNotDeletedException - the entity was not deleted; GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreSoftwareServerCapability

public SoftwareServerCapability restoreSoftwareServerCapability(String userId,
                                                                String entityGuid)
                                                         throws MetadataServerUncontactableException,
                                                                UserNotAuthorizedException,
                                                                InvalidParameterException,
                                                                UnrecognizedGUIDException,
                                                                GUIDNotDeletedException,
                                                                FunctionNotSupportedException

Restore an SoftwareServerCapability identified by its GUID. Restore resurrects a soft deleted SoftwareServerCapability. When a SoftwareServerCapability was incorrectly deleted, the delete can be undone using the restore..

Parameters:: userId - user identity; entityGuid - GUID for the SoftwareServerCapability
Returns:: SoftwareServerCapability the restored SoftwareServerCapability
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; GUIDNotDeletedException - the guid of the SoftwareServerCapability is not deleted, so cannot be restored; FunctionNotSupportedException - Function not supported

addSoftwareServerCapabilityClassifications

public SoftwareServerCapability addSoftwareServerCapabilityClassifications(String userId,
                                                                           String entityGuid,
                                                                           List<Classification> classifications)
                                                                    throws MetadataServerUncontactableException,
                                                                           UserNotAuthorizedException,
                                                                           InvalidParameterException,
                                                                           ClassificationException,
                                                                           UnrecognizedGUIDException

Add classifications to the supplied softwareServerCapability

Parameters:: userId - user identity; entityGuid - the GUID value for softwareServerCapability; classifications - the classifications to apply.
Returns:: the softwareServerCapability entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateSoftwareServerCapabilityClassification

public SoftwareServerCapability updateSoftwareServerCapabilityClassification(String userId,
                                                                             String entityGuid,
                                                                             List<Classification> classificationsToUpdate)
                                                                      throws MetadataServerUncontactableException,
                                                                             UserNotAuthorizedException,
                                                                             InvalidParameterException,
                                                                             ClassificationException,
                                                                             UnrecognizedGUIDException

Updates classifications to an existing softwareServerCapability represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the softwareServerCapability; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given softwareServerCapability guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteSoftwareServerCapabilityClassification

public SoftwareServerCapability deleteSoftwareServerCapabilityClassification(String userId,
                                                                             String entityGuid,
                                                                             String name)
                                                                      throws MetadataServerUncontactableException,
                                                                             UserNotAuthorizedException,
                                                                             InvalidParameterException,
                                                                             ClassificationException,
                                                                             UnrecognizedGUIDException

Deletes a given classification from an existing softwareServerCapability represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the softwareServerCapability; name - name of the classification
Returns:: deleted SoftwareServerCapability classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getSoftwareServerCapabilityRelationships
```
public Set<Line> getSoftwareServerCapabilityRelationships(String userId,
                                                          String entityGuid,
                                                          String relationshipTypeGuid,
                                                          int fromRelationshipElement,
                                                          Date asOfTime,
                                                          String sequencingProperty,
                                                          SequencingOrder sequencingOrder,
                                                          int pageSize)
                                                   throws MetadataServerUncontactableException,
                                                          UserNotAuthorizedException,
                                                          InvalidParameterException,
                                                          FunctionNotSupportedException,
                                                          UnrecognizedGUIDException
```
Get the relationships associated with entity softwareServerCapability represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the softwareServerCapability

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getLicenseTypeById
```
public LicenseType getLicenseTypeById(String userId,
                                      String entityGuid)
                               throws MetadataServerUncontactableException,
                                      UserNotAuthorizedException,
                                      InvalidParameterException,
                                      UnrecognizedGUIDException
```
Fetch complete definition of an licenseType given its GUID. The limit and offset paging parameters limit the number elements returned in each of the licenseTypes relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

LicenseType the LicenseType entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createLicenseType

public LicenseType createLicenseType(String userId,
                                     LicenseType licenseType)
                              throws MetadataServerUncontactableException,
                                     UserNotAuthorizedException,
                                     InvalidParameterException,
                                     ClassificationException,
                                     StatusNotSupportedException

Create new licenseType.

Parameters:: userId - user identity; licenseType - the input entity with values.
Returns:: LicenseType the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateLicenseType
```
public LicenseType updateLicenseType(String userId,
                                     LicenseType licenseType)
                              throws MetadataServerUncontactableException,
                                     UserNotAuthorizedException,
                                     InvalidParameterException,
                                     UnrecognizedGUIDException
```
Update licenseType

Parameters:

userId - user identity

licenseType - licenseType to update

Returns:

LicenseType the updated licenseType entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteLicenseTypeByGuid
```
public EntityDetail deleteLicenseTypeByGuid(String userId,
                                            String entityGuid)
                                     throws MetadataServerUncontactableException,
                                            UserNotAuthorizedException,
                                            FunctionNotSupportedException,
                                            InvalidParameterException,
                                            UnrecognizedGUIDException
```
Delete an licenseType identified by its GUID. Delete is a soft delete, this means that the licenseType has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the licenseType

Returns:

LicenseType the deleted LicenseType entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeLicenseTypeByGuid
```
public void purgeLicenseTypeByGuid(String userId,
                                   String entityGuid)
                            throws MetadataServerUncontactableException,
                                   UserNotAuthorizedException,
                                   InvalidParameterException,
                                   UnrecognizedGUIDException,
                                   EntityNotDeletedException,
                                   GUIDNotPurgedException
```
Purge an licenseType identified by its GUID. Delete is a hard delete, this means that the licenseType is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the licenseType

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreLicenseType
```
public LicenseType restoreLicenseType(String userId,
                                      String entityGuid)
                               throws MetadataServerUncontactableException,
                                      UserNotAuthorizedException,
                                      InvalidParameterException,
                                      UnrecognizedGUIDException,
                                      GUIDNotDeletedException,
                                      FunctionNotSupportedException
```
Restore an LicenseType identified by its GUID. Restore resurrects a soft deleted LicenseType. When a LicenseType was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the LicenseType

Returns:

LicenseType the restored LicenseType

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the LicenseType is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addLicenseTypeClassifications

public LicenseType addLicenseTypeClassifications(String userId,
                                                 String entityGuid,
                                                 List<Classification> classifications)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 ClassificationException,
                                                 UnrecognizedGUIDException

Add classifications to the supplied licenseType

Parameters:: userId - user identity; entityGuid - the GUID value for licenseType; classifications - the classifications to apply.
Returns:: the licenseType entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateLicenseTypeClassification

public LicenseType updateLicenseTypeClassification(String userId,
                                                   String entityGuid,
                                                   List<Classification> classificationsToUpdate)
                                            throws MetadataServerUncontactableException,
                                                   UserNotAuthorizedException,
                                                   InvalidParameterException,
                                                   ClassificationException,
                                                   UnrecognizedGUIDException

Updates classifications to an existing licenseType represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the licenseType; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given licenseType guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteLicenseTypeClassification

public LicenseType deleteLicenseTypeClassification(String userId,
                                                   String entityGuid,
                                                   String name)
                                            throws MetadataServerUncontactableException,
                                                   UserNotAuthorizedException,
                                                   InvalidParameterException,
                                                   ClassificationException,
                                                   UnrecognizedGUIDException

Deletes a given classification from an existing licenseType represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the licenseType; name - name of the classification
Returns:: deleted LicenseType classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getLicenseTypeRelationships
```
public Set<Line> getLicenseTypeRelationships(String userId,
                                             String entityGuid,
                                             String relationshipTypeGuid,
                                             int fromRelationshipElement,
                                             Date asOfTime,
                                             String sequencingProperty,
                                             SequencingOrder sequencingOrder,
                                             int pageSize)
                                      throws MetadataServerUncontactableException,
                                             UserNotAuthorizedException,
                                             InvalidParameterException,
                                             FunctionNotSupportedException,
                                             UnrecognizedGUIDException
```
Get the relationships associated with entity licenseType represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the licenseType

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getGraphVertexById
```
public GraphVertex getGraphVertexById(String userId,
                                      String entityGuid)
                               throws MetadataServerUncontactableException,
                                      UserNotAuthorizedException,
                                      InvalidParameterException,
                                      UnrecognizedGUIDException
```
Fetch complete definition of an graphVertex given its GUID. The limit and offset paging parameters limit the number elements returned in each of the graphVertexs relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

GraphVertex the GraphVertex entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createGraphVertex

public GraphVertex createGraphVertex(String userId,
                                     GraphVertex graphVertex)
                              throws MetadataServerUncontactableException,
                                     UserNotAuthorizedException,
                                     InvalidParameterException,
                                     ClassificationException,
                                     StatusNotSupportedException

Create new graphVertex.

Parameters:: userId - user identity; graphVertex - the input entity with values.
Returns:: GraphVertex the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateGraphVertex
```
public GraphVertex updateGraphVertex(String userId,
                                     GraphVertex graphVertex)
                              throws MetadataServerUncontactableException,
                                     UserNotAuthorizedException,
                                     InvalidParameterException,
                                     UnrecognizedGUIDException
```
Update graphVertex

Parameters:

userId - user identity

graphVertex - graphVertex to update

Returns:

GraphVertex the updated graphVertex entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteGraphVertexByGuid
```
public EntityDetail deleteGraphVertexByGuid(String userId,
                                            String entityGuid)
                                     throws MetadataServerUncontactableException,
                                            UserNotAuthorizedException,
                                            FunctionNotSupportedException,
                                            InvalidParameterException,
                                            UnrecognizedGUIDException
```
Delete an graphVertex identified by its GUID. Delete is a soft delete, this means that the graphVertex has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the graphVertex

Returns:

GraphVertex the deleted GraphVertex entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeGraphVertexByGuid
```
public void purgeGraphVertexByGuid(String userId,
                                   String entityGuid)
                            throws MetadataServerUncontactableException,
                                   UserNotAuthorizedException,
                                   InvalidParameterException,
                                   UnrecognizedGUIDException,
                                   EntityNotDeletedException,
                                   GUIDNotPurgedException
```
Purge an graphVertex identified by its GUID. Delete is a hard delete, this means that the graphVertex is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the graphVertex

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreGraphVertex
```
public GraphVertex restoreGraphVertex(String userId,
                                      String entityGuid)
                               throws MetadataServerUncontactableException,
                                      UserNotAuthorizedException,
                                      InvalidParameterException,
                                      UnrecognizedGUIDException,
                                      GUIDNotDeletedException,
                                      FunctionNotSupportedException
```
Restore an GraphVertex identified by its GUID. Restore resurrects a soft deleted GraphVertex. When a GraphVertex was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the GraphVertex

Returns:

GraphVertex the restored GraphVertex

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the GraphVertex is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addGraphVertexClassifications

public GraphVertex addGraphVertexClassifications(String userId,
                                                 String entityGuid,
                                                 List<Classification> classifications)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 ClassificationException,
                                                 UnrecognizedGUIDException

Add classifications to the supplied graphVertex

Parameters:: userId - user identity; entityGuid - the GUID value for graphVertex; classifications - the classifications to apply.
Returns:: the graphVertex entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateGraphVertexClassification

public GraphVertex updateGraphVertexClassification(String userId,
                                                   String entityGuid,
                                                   List<Classification> classificationsToUpdate)
                                            throws MetadataServerUncontactableException,
                                                   UserNotAuthorizedException,
                                                   InvalidParameterException,
                                                   ClassificationException,
                                                   UnrecognizedGUIDException

Updates classifications to an existing graphVertex represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the graphVertex; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given graphVertex guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteGraphVertexClassification

public GraphVertex deleteGraphVertexClassification(String userId,
                                                   String entityGuid,
                                                   String name)
                                            throws MetadataServerUncontactableException,
                                                   UserNotAuthorizedException,
                                                   InvalidParameterException,
                                                   ClassificationException,
                                                   UnrecognizedGUIDException

Deletes a given classification from an existing graphVertex represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the graphVertex; name - name of the classification
Returns:: deleted GraphVertex classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getGraphVertexRelationships
```
public Set<Line> getGraphVertexRelationships(String userId,
                                             String entityGuid,
                                             String relationshipTypeGuid,
                                             int fromRelationshipElement,
                                             Date asOfTime,
                                             String sequencingProperty,
                                             SequencingOrder sequencingOrder,
                                             int pageSize)
                                      throws MetadataServerUncontactableException,
                                             UserNotAuthorizedException,
                                             InvalidParameterException,
                                             FunctionNotSupportedException,
                                             UnrecognizedGUIDException
```
Get the relationships associated with entity graphVertex represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the graphVertex

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getGlossaryTermById
```
public GlossaryTerm getGlossaryTermById(String userId,
                                        String entityGuid)
                                 throws MetadataServerUncontactableException,
                                        UserNotAuthorizedException,
                                        InvalidParameterException,
                                        UnrecognizedGUIDException
```
Fetch complete definition of an glossaryTerm given its GUID. The limit and offset paging parameters limit the number elements returned in each of the glossaryTerms relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

GlossaryTerm the GlossaryTerm entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createGlossaryTerm

public GlossaryTerm createGlossaryTerm(String userId,
                                       GlossaryTerm glossaryTerm)
                                throws MetadataServerUncontactableException,
                                       UserNotAuthorizedException,
                                       InvalidParameterException,
                                       ClassificationException,
                                       StatusNotSupportedException

Create new glossaryTerm.

Parameters:: userId - user identity; glossaryTerm - the input entity with values.
Returns:: GlossaryTerm the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateGlossaryTerm
```
public GlossaryTerm updateGlossaryTerm(String userId,
                                       GlossaryTerm glossaryTerm)
                                throws MetadataServerUncontactableException,
                                       UserNotAuthorizedException,
                                       InvalidParameterException,
                                       UnrecognizedGUIDException
```
Update glossaryTerm

Parameters:

userId - user identity

glossaryTerm - glossaryTerm to update

Returns:

GlossaryTerm the updated glossaryTerm entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteGlossaryTermByGuid
```
public EntityDetail deleteGlossaryTermByGuid(String userId,
                                             String entityGuid)
                                      throws MetadataServerUncontactableException,
                                             UserNotAuthorizedException,
                                             FunctionNotSupportedException,
                                             InvalidParameterException,
                                             UnrecognizedGUIDException
```
Delete an glossaryTerm identified by its GUID. Delete is a soft delete, this means that the glossaryTerm has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the glossaryTerm

Returns:

GlossaryTerm the deleted GlossaryTerm entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeGlossaryTermByGuid
```
public void purgeGlossaryTermByGuid(String userId,
                                    String entityGuid)
                             throws MetadataServerUncontactableException,
                                    UserNotAuthorizedException,
                                    InvalidParameterException,
                                    UnrecognizedGUIDException,
                                    EntityNotDeletedException,
                                    GUIDNotPurgedException
```
Purge an glossaryTerm identified by its GUID. Delete is a hard delete, this means that the glossaryTerm is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the glossaryTerm

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreGlossaryTerm
```
public GlossaryTerm restoreGlossaryTerm(String userId,
                                        String entityGuid)
                                 throws MetadataServerUncontactableException,
                                        UserNotAuthorizedException,
                                        InvalidParameterException,
                                        UnrecognizedGUIDException,
                                        GUIDNotDeletedException,
                                        FunctionNotSupportedException
```
Restore an GlossaryTerm identified by its GUID. Restore resurrects a soft deleted GlossaryTerm. When a GlossaryTerm was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the GlossaryTerm

Returns:

GlossaryTerm the restored GlossaryTerm

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the GlossaryTerm is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addGlossaryTermClassifications

public GlossaryTerm addGlossaryTermClassifications(String userId,
                                                   String entityGuid,
                                                   List<Classification> classifications)
                                            throws MetadataServerUncontactableException,
                                                   UserNotAuthorizedException,
                                                   InvalidParameterException,
                                                   ClassificationException,
                                                   UnrecognizedGUIDException

Add classifications to the supplied glossaryTerm

Parameters:: userId - user identity; entityGuid - the GUID value for glossaryTerm; classifications - the classifications to apply.
Returns:: the glossaryTerm entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateGlossaryTermClassification

public GlossaryTerm updateGlossaryTermClassification(String userId,
                                                     String entityGuid,
                                                     List<Classification> classificationsToUpdate)
                                              throws MetadataServerUncontactableException,
                                                     UserNotAuthorizedException,
                                                     InvalidParameterException,
                                                     ClassificationException,
                                                     UnrecognizedGUIDException

Updates classifications to an existing glossaryTerm represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the glossaryTerm; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given glossaryTerm guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteGlossaryTermClassification

public GlossaryTerm deleteGlossaryTermClassification(String userId,
                                                     String entityGuid,
                                                     String name)
                                              throws MetadataServerUncontactableException,
                                                     UserNotAuthorizedException,
                                                     InvalidParameterException,
                                                     ClassificationException,
                                                     UnrecognizedGUIDException

Deletes a given classification from an existing glossaryTerm represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the glossaryTerm; name - name of the classification
Returns:: deleted GlossaryTerm classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getGlossaryTermRelationships
```
public Set<Line> getGlossaryTermRelationships(String userId,
                                              String entityGuid,
                                              String relationshipTypeGuid,
                                              int fromRelationshipElement,
                                              Date asOfTime,
                                              String sequencingProperty,
                                              SequencingOrder sequencingOrder,
                                              int pageSize)
                                       throws MetadataServerUncontactableException,
                                              UserNotAuthorizedException,
                                              InvalidParameterException,
                                              FunctionNotSupportedException,
                                              UnrecognizedGUIDException
```
Get the relationships associated with entity glossaryTerm represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the glossaryTerm

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getTeamById
```
public Team getTeamById(String userId,
                        String entityGuid)
                 throws MetadataServerUncontactableException,
                        UserNotAuthorizedException,
                        InvalidParameterException,
                        UnrecognizedGUIDException
```
Fetch complete definition of an team given its GUID. The limit and offset paging parameters limit the number elements returned in each of the teams relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

Team the Team entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createTeam
```
public Team createTeam(String userId,
                       Team team)
                throws MetadataServerUncontactableException,
                       UserNotAuthorizedException,
                       InvalidParameterException,
                       ClassificationException,
                       StatusNotSupportedException
```
Create new team.

Parameters:

userId - user identity

team - the input entity with values.

Returns:

Team the created entity.

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

ClassificationException - a classification does not match constraints.

StatusNotSupportedException - status is not supported

updateTeam
```
public Team updateTeam(String userId,
                       Team team)
                throws MetadataServerUncontactableException,
                       UserNotAuthorizedException,
                       InvalidParameterException,
                       UnrecognizedGUIDException
```
Update team

Parameters:

userId - user identity

team - team to update

Returns:

Team the updated team entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteTeamByGuid
```
public EntityDetail deleteTeamByGuid(String userId,
                                     String entityGuid)
                              throws MetadataServerUncontactableException,
                                     UserNotAuthorizedException,
                                     FunctionNotSupportedException,
                                     InvalidParameterException,
                                     UnrecognizedGUIDException
```
Delete an team identified by its GUID. Delete is a soft delete, this means that the team has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the team

Returns:

Team the deleted Team entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeTeamByGuid
```
public void purgeTeamByGuid(String userId,
                            String entityGuid)
                     throws MetadataServerUncontactableException,
                            UserNotAuthorizedException,
                            InvalidParameterException,
                            UnrecognizedGUIDException,
                            EntityNotDeletedException,
                            GUIDNotPurgedException
```
Purge an team identified by its GUID. Delete is a hard delete, this means that the team is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the team

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreTeam
```
public Team restoreTeam(String userId,
                        String entityGuid)
                 throws MetadataServerUncontactableException,
                        UserNotAuthorizedException,
                        InvalidParameterException,
                        UnrecognizedGUIDException,
                        GUIDNotDeletedException,
                        FunctionNotSupportedException
```
Restore an Team identified by its GUID. Restore resurrects a soft deleted Team. When a Team was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the Team

Returns:

Team the restored Team

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the Team is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addTeamClassifications

public Team addTeamClassifications(String userId,
                                   String entityGuid,
                                   List<Classification> classifications)
                            throws MetadataServerUncontactableException,
                                   UserNotAuthorizedException,
                                   InvalidParameterException,
                                   ClassificationException,
                                   UnrecognizedGUIDException

Add classifications to the supplied team

Parameters:: userId - user identity; entityGuid - the GUID value for team; classifications - the classifications to apply.
Returns:: the team entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateTeamClassification
```
public Team updateTeamClassification(String userId,
                                     String entityGuid,
                                     List<Classification> classificationsToUpdate)
                              throws MetadataServerUncontactableException,
                                     UserNotAuthorizedException,
                                     InvalidParameterException,
                                     ClassificationException,
                                     UnrecognizedGUIDException
```
Updates classifications to an existing team represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the team

classificationsToUpdate - List of classifications to update entity with

Returns:

classification for the given team guid

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

ClassificationException - a classification does not match constraints.

deleteTeamClassification
```
public Team deleteTeamClassification(String userId,
                                     String entityGuid,
                                     String name)
                              throws MetadataServerUncontactableException,
                                     UserNotAuthorizedException,
                                     InvalidParameterException,
                                     ClassificationException,
                                     UnrecognizedGUIDException
```
Deletes a given classification from an existing team represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the team

name - name of the classification

Returns:

deleted Team classification

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

ClassificationException - a classification does not match constraints.

getTeamRelationships
```
public Set<Line> getTeamRelationships(String userId,
                                      String entityGuid,
                                      String relationshipTypeGuid,
                                      int fromRelationshipElement,
                                      Date asOfTime,
                                      String sequencingProperty,
                                      SequencingOrder sequencingOrder,
                                      int pageSize)
                               throws MetadataServerUncontactableException,
                                      UserNotAuthorizedException,
                                      InvalidParameterException,
                                      FunctionNotSupportedException,
                                      UnrecognizedGUIDException
```
Get the relationships associated with entity team represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the team

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getMetadataCollectionById
```
public MetadataCollection getMetadataCollectionById(String userId,
                                                    String entityGuid)
                                             throws MetadataServerUncontactableException,
                                                    UserNotAuthorizedException,
                                                    InvalidParameterException,
                                                    UnrecognizedGUIDException
```
Fetch complete definition of an metadataCollection given its GUID. The limit and offset paging parameters limit the number elements returned in each of the metadataCollections relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

MetadataCollection the MetadataCollection entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createMetadataCollection

public MetadataCollection createMetadataCollection(String userId,
                                                   MetadataCollection metadataCollection)
                                            throws MetadataServerUncontactableException,
                                                   UserNotAuthorizedException,
                                                   InvalidParameterException,
                                                   ClassificationException,
                                                   StatusNotSupportedException

Create new metadataCollection.

Parameters:: userId - user identity; metadataCollection - the input entity with values.
Returns:: MetadataCollection the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateMetadataCollection

public MetadataCollection updateMetadataCollection(String userId,
                                                   MetadataCollection metadataCollection)
                                            throws MetadataServerUncontactableException,
                                                   UserNotAuthorizedException,
                                                   InvalidParameterException,
                                                   UnrecognizedGUIDException

Update metadataCollection

Parameters:: userId - user identity; metadataCollection - metadataCollection to update
Returns:: MetadataCollection the updated metadataCollection entity
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteMetadataCollectionByGuid
```
public EntityDetail deleteMetadataCollectionByGuid(String userId,
                                                   String entityGuid)
                                            throws MetadataServerUncontactableException,
                                                   UserNotAuthorizedException,
                                                   FunctionNotSupportedException,
                                                   InvalidParameterException,
                                                   UnrecognizedGUIDException
```
Delete an metadataCollection identified by its GUID. Delete is a soft delete, this means that the metadataCollection has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the metadataCollection

Returns:

MetadataCollection the deleted MetadataCollection entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeMetadataCollectionByGuid
```
public void purgeMetadataCollectionByGuid(String userId,
                                          String entityGuid)
                                   throws MetadataServerUncontactableException,
                                          UserNotAuthorizedException,
                                          InvalidParameterException,
                                          UnrecognizedGUIDException,
                                          EntityNotDeletedException,
                                          GUIDNotPurgedException
```
Purge an metadataCollection identified by its GUID. Delete is a hard delete, this means that the metadataCollection is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the metadataCollection

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreMetadataCollection

public MetadataCollection restoreMetadataCollection(String userId,
                                                    String entityGuid)
                                             throws MetadataServerUncontactableException,
                                                    UserNotAuthorizedException,
                                                    InvalidParameterException,
                                                    UnrecognizedGUIDException,
                                                    GUIDNotDeletedException,
                                                    FunctionNotSupportedException

Restore an MetadataCollection identified by its GUID. Restore resurrects a soft deleted MetadataCollection. When a MetadataCollection was incorrectly deleted, the delete can be undone using the restore..

Parameters:: userId - user identity; entityGuid - GUID for the MetadataCollection
Returns:: MetadataCollection the restored MetadataCollection
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; GUIDNotDeletedException - the guid of the MetadataCollection is not deleted, so cannot be restored; FunctionNotSupportedException - Function not supported

addMetadataCollectionClassifications

public MetadataCollection addMetadataCollectionClassifications(String userId,
                                                               String entityGuid,
                                                               List<Classification> classifications)
                                                        throws MetadataServerUncontactableException,
                                                               UserNotAuthorizedException,
                                                               InvalidParameterException,
                                                               ClassificationException,
                                                               UnrecognizedGUIDException

Add classifications to the supplied metadataCollection

Parameters:: userId - user identity; entityGuid - the GUID value for metadataCollection; classifications - the classifications to apply.
Returns:: the metadataCollection entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateMetadataCollectionClassification

public MetadataCollection updateMetadataCollectionClassification(String userId,
                                                                 String entityGuid,
                                                                 List<Classification> classificationsToUpdate)
                                                          throws MetadataServerUncontactableException,
                                                                 UserNotAuthorizedException,
                                                                 InvalidParameterException,
                                                                 ClassificationException,
                                                                 UnrecognizedGUIDException

Updates classifications to an existing metadataCollection represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the metadataCollection; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given metadataCollection guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteMetadataCollectionClassification

public MetadataCollection deleteMetadataCollectionClassification(String userId,
                                                                 String entityGuid,
                                                                 String name)
                                                          throws MetadataServerUncontactableException,
                                                                 UserNotAuthorizedException,
                                                                 InvalidParameterException,
                                                                 ClassificationException,
                                                                 UnrecognizedGUIDException

Deletes a given classification from an existing metadataCollection represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the metadataCollection; name - name of the classification
Returns:: deleted MetadataCollection classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getMetadataCollectionRelationships
```
public Set<Line> getMetadataCollectionRelationships(String userId,
                                                    String entityGuid,
                                                    String relationshipTypeGuid,
                                                    int fromRelationshipElement,
                                                    Date asOfTime,
                                                    String sequencingProperty,
                                                    SequencingOrder sequencingOrder,
                                                    int pageSize)
                                             throws MetadataServerUncontactableException,
                                                    UserNotAuthorizedException,
                                                    InvalidParameterException,
                                                    FunctionNotSupportedException,
                                                    UnrecognizedGUIDException
```
Get the relationships associated with entity metadataCollection represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the metadataCollection

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getGovernanceControlById
```
public GovernanceControl getGovernanceControlById(String userId,
                                                  String entityGuid)
                                           throws MetadataServerUncontactableException,
                                                  UserNotAuthorizedException,
                                                  InvalidParameterException,
                                                  UnrecognizedGUIDException
```
Fetch complete definition of an governanceControl given its GUID. The limit and offset paging parameters limit the number elements returned in each of the governanceControls relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

GovernanceControl the GovernanceControl entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createGovernanceControl

public GovernanceControl createGovernanceControl(String userId,
                                                 GovernanceControl governanceControl)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 ClassificationException,
                                                 StatusNotSupportedException

Create new governanceControl.

Parameters:: userId - user identity; governanceControl - the input entity with values.
Returns:: GovernanceControl the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateGovernanceControl

public GovernanceControl updateGovernanceControl(String userId,
                                                 GovernanceControl governanceControl)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 UnrecognizedGUIDException

Update governanceControl

Parameters:: userId - user identity; governanceControl - governanceControl to update
Returns:: GovernanceControl the updated governanceControl entity
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteGovernanceControlByGuid
```
public EntityDetail deleteGovernanceControlByGuid(String userId,
                                                  String entityGuid)
                                           throws MetadataServerUncontactableException,
                                                  UserNotAuthorizedException,
                                                  FunctionNotSupportedException,
                                                  InvalidParameterException,
                                                  UnrecognizedGUIDException
```
Delete an governanceControl identified by its GUID. Delete is a soft delete, this means that the governanceControl has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the governanceControl

Returns:

GovernanceControl the deleted GovernanceControl entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeGovernanceControlByGuid
```
public void purgeGovernanceControlByGuid(String userId,
                                         String entityGuid)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         InvalidParameterException,
                                         UnrecognizedGUIDException,
                                         EntityNotDeletedException,
                                         GUIDNotPurgedException
```
Purge an governanceControl identified by its GUID. Delete is a hard delete, this means that the governanceControl is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the governanceControl

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreGovernanceControl
```
public GovernanceControl restoreGovernanceControl(String userId,
                                                  String entityGuid)
                                           throws MetadataServerUncontactableException,
                                                  UserNotAuthorizedException,
                                                  InvalidParameterException,
                                                  UnrecognizedGUIDException,
                                                  GUIDNotDeletedException,
                                                  FunctionNotSupportedException
```
Restore an GovernanceControl identified by its GUID. Restore resurrects a soft deleted GovernanceControl. When a GovernanceControl was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the GovernanceControl

Returns:

GovernanceControl the restored GovernanceControl

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the GovernanceControl is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addGovernanceControlClassifications

public GovernanceControl addGovernanceControlClassifications(String userId,
                                                             String entityGuid,
                                                             List<Classification> classifications)
                                                      throws MetadataServerUncontactableException,
                                                             UserNotAuthorizedException,
                                                             InvalidParameterException,
                                                             ClassificationException,
                                                             UnrecognizedGUIDException

Add classifications to the supplied governanceControl

Parameters:: userId - user identity; entityGuid - the GUID value for governanceControl; classifications - the classifications to apply.
Returns:: the governanceControl entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateGovernanceControlClassification

public GovernanceControl updateGovernanceControlClassification(String userId,
                                                               String entityGuid,
                                                               List<Classification> classificationsToUpdate)
                                                        throws MetadataServerUncontactableException,
                                                               UserNotAuthorizedException,
                                                               InvalidParameterException,
                                                               ClassificationException,
                                                               UnrecognizedGUIDException

Updates classifications to an existing governanceControl represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the governanceControl; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given governanceControl guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteGovernanceControlClassification

public GovernanceControl deleteGovernanceControlClassification(String userId,
                                                               String entityGuid,
                                                               String name)
                                                        throws MetadataServerUncontactableException,
                                                               UserNotAuthorizedException,
                                                               InvalidParameterException,
                                                               ClassificationException,
                                                               UnrecognizedGUIDException

Deletes a given classification from an existing governanceControl represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the governanceControl; name - name of the classification
Returns:: deleted GovernanceControl classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getGovernanceControlRelationships
```
public Set<Line> getGovernanceControlRelationships(String userId,
                                                   String entityGuid,
                                                   String relationshipTypeGuid,
                                                   int fromRelationshipElement,
                                                   Date asOfTime,
                                                   String sequencingProperty,
                                                   SequencingOrder sequencingOrder,
                                                   int pageSize)
                                            throws MetadataServerUncontactableException,
                                                   UserNotAuthorizedException,
                                                   InvalidParameterException,
                                                   FunctionNotSupportedException,
                                                   UnrecognizedGUIDException
```
Get the relationships associated with entity governanceControl represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the governanceControl

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getTopicById
```
public Topic getTopicById(String userId,
                          String entityGuid)
                   throws MetadataServerUncontactableException,
                          UserNotAuthorizedException,
                          InvalidParameterException,
                          UnrecognizedGUIDException
```
Fetch complete definition of an topic given its GUID. The limit and offset paging parameters limit the number elements returned in each of the topics relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

Topic the Topic entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createTopic
```
public Topic createTopic(String userId,
                         Topic topic)
                  throws MetadataServerUncontactableException,
                         UserNotAuthorizedException,
                         InvalidParameterException,
                         ClassificationException,
                         StatusNotSupportedException
```
Create new topic.

Parameters:

userId - user identity

topic - the input entity with values.

Returns:

Topic the created entity.

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

ClassificationException - a classification does not match constraints.

StatusNotSupportedException - status is not supported

updateTopic
```
public Topic updateTopic(String userId,
                         Topic topic)
                  throws MetadataServerUncontactableException,
                         UserNotAuthorizedException,
                         InvalidParameterException,
                         UnrecognizedGUIDException
```
Update topic

Parameters:

userId - user identity

topic - topic to update

Returns:

Topic the updated topic entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteTopicByGuid
```
public EntityDetail deleteTopicByGuid(String userId,
                                      String entityGuid)
                               throws MetadataServerUncontactableException,
                                      UserNotAuthorizedException,
                                      FunctionNotSupportedException,
                                      InvalidParameterException,
                                      UnrecognizedGUIDException
```
Delete an topic identified by its GUID. Delete is a soft delete, this means that the topic has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the topic

Returns:

Topic the deleted Topic entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeTopicByGuid
```
public void purgeTopicByGuid(String userId,
                             String entityGuid)
                      throws MetadataServerUncontactableException,
                             UserNotAuthorizedException,
                             InvalidParameterException,
                             UnrecognizedGUIDException,
                             EntityNotDeletedException,
                             GUIDNotPurgedException
```
Purge an topic identified by its GUID. Delete is a hard delete, this means that the topic is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the topic

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreTopic
```
public Topic restoreTopic(String userId,
                          String entityGuid)
                   throws MetadataServerUncontactableException,
                          UserNotAuthorizedException,
                          InvalidParameterException,
                          UnrecognizedGUIDException,
                          GUIDNotDeletedException,
                          FunctionNotSupportedException
```
Restore an Topic identified by its GUID. Restore resurrects a soft deleted Topic. When a Topic was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the Topic

Returns:

Topic the restored Topic

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the Topic is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addTopicClassifications

public Topic addTopicClassifications(String userId,
                                     String entityGuid,
                                     List<Classification> classifications)
                              throws MetadataServerUncontactableException,
                                     UserNotAuthorizedException,
                                     InvalidParameterException,
                                     ClassificationException,
                                     UnrecognizedGUIDException

Add classifications to the supplied topic

Parameters:: userId - user identity; entityGuid - the GUID value for topic; classifications - the classifications to apply.
Returns:: the topic entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateTopicClassification
```
public Topic updateTopicClassification(String userId,
                                       String entityGuid,
                                       List<Classification> classificationsToUpdate)
                                throws MetadataServerUncontactableException,
                                       UserNotAuthorizedException,
                                       InvalidParameterException,
                                       ClassificationException,
                                       UnrecognizedGUIDException
```
Updates classifications to an existing topic represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the topic

classificationsToUpdate - List of classifications to update entity with

Returns:

classification for the given topic guid

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

ClassificationException - a classification does not match constraints.

deleteTopicClassification

public Topic deleteTopicClassification(String userId,
                                       String entityGuid,
                                       String name)
                                throws MetadataServerUncontactableException,
                                       UserNotAuthorizedException,
                                       InvalidParameterException,
                                       ClassificationException,
                                       UnrecognizedGUIDException

Deletes a given classification from an existing topic represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the topic; name - name of the classification
Returns:: deleted Topic classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getTopicRelationships
```
public Set<Line> getTopicRelationships(String userId,
                                       String entityGuid,
                                       String relationshipTypeGuid,
                                       int fromRelationshipElement,
                                       Date asOfTime,
                                       String sequencingProperty,
                                       SequencingOrder sequencingOrder,
                                       int pageSize)
                                throws MetadataServerUncontactableException,
                                       UserNotAuthorizedException,
                                       InvalidParameterException,
                                       FunctionNotSupportedException,
                                       UnrecognizedGUIDException
```
Get the relationships associated with entity topic represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the topic

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getSoftwareServerById
```
public SoftwareServer getSoftwareServerById(String userId,
                                            String entityGuid)
                                     throws MetadataServerUncontactableException,
                                            UserNotAuthorizedException,
                                            InvalidParameterException,
                                            UnrecognizedGUIDException
```
Fetch complete definition of an softwareServer given its GUID. The limit and offset paging parameters limit the number elements returned in each of the softwareServers relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

SoftwareServer the SoftwareServer entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createSoftwareServer

public SoftwareServer createSoftwareServer(String userId,
                                           SoftwareServer softwareServer)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           InvalidParameterException,
                                           ClassificationException,
                                           StatusNotSupportedException

Create new softwareServer.

Parameters:: userId - user identity; softwareServer - the input entity with values.
Returns:: SoftwareServer the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateSoftwareServer

public SoftwareServer updateSoftwareServer(String userId,
                                           SoftwareServer softwareServer)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           InvalidParameterException,
                                           UnrecognizedGUIDException

Update softwareServer

Parameters:: userId - user identity; softwareServer - softwareServer to update
Returns:: SoftwareServer the updated softwareServer entity
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteSoftwareServerByGuid
```
public EntityDetail deleteSoftwareServerByGuid(String userId,
                                               String entityGuid)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               FunctionNotSupportedException,
                                               InvalidParameterException,
                                               UnrecognizedGUIDException
```
Delete an softwareServer identified by its GUID. Delete is a soft delete, this means that the softwareServer has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the softwareServer

Returns:

SoftwareServer the deleted SoftwareServer entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeSoftwareServerByGuid
```
public void purgeSoftwareServerByGuid(String userId,
                                      String entityGuid)
                               throws MetadataServerUncontactableException,
                                      UserNotAuthorizedException,
                                      InvalidParameterException,
                                      UnrecognizedGUIDException,
                                      EntityNotDeletedException,
                                      GUIDNotPurgedException
```
Purge an softwareServer identified by its GUID. Delete is a hard delete, this means that the softwareServer is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the softwareServer

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreSoftwareServer
```
public SoftwareServer restoreSoftwareServer(String userId,
                                            String entityGuid)
                                     throws MetadataServerUncontactableException,
                                            UserNotAuthorizedException,
                                            InvalidParameterException,
                                            UnrecognizedGUIDException,
                                            GUIDNotDeletedException,
                                            FunctionNotSupportedException
```
Restore an SoftwareServer identified by its GUID. Restore resurrects a soft deleted SoftwareServer. When a SoftwareServer was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the SoftwareServer

Returns:

SoftwareServer the restored SoftwareServer

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the SoftwareServer is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addSoftwareServerClassifications

public SoftwareServer addSoftwareServerClassifications(String userId,
                                                       String entityGuid,
                                                       List<Classification> classifications)
                                                throws MetadataServerUncontactableException,
                                                       UserNotAuthorizedException,
                                                       InvalidParameterException,
                                                       ClassificationException,
                                                       UnrecognizedGUIDException

Add classifications to the supplied softwareServer

Parameters:: userId - user identity; entityGuid - the GUID value for softwareServer; classifications - the classifications to apply.
Returns:: the softwareServer entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateSoftwareServerClassification

public SoftwareServer updateSoftwareServerClassification(String userId,
                                                         String entityGuid,
                                                         List<Classification> classificationsToUpdate)
                                                  throws MetadataServerUncontactableException,
                                                         UserNotAuthorizedException,
                                                         InvalidParameterException,
                                                         ClassificationException,
                                                         UnrecognizedGUIDException

Updates classifications to an existing softwareServer represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the softwareServer; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given softwareServer guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteSoftwareServerClassification

public SoftwareServer deleteSoftwareServerClassification(String userId,
                                                         String entityGuid,
                                                         String name)
                                                  throws MetadataServerUncontactableException,
                                                         UserNotAuthorizedException,
                                                         InvalidParameterException,
                                                         ClassificationException,
                                                         UnrecognizedGUIDException

Deletes a given classification from an existing softwareServer represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the softwareServer; name - name of the classification
Returns:: deleted SoftwareServer classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getSoftwareServerRelationships
```
public Set<Line> getSoftwareServerRelationships(String userId,
                                                String entityGuid,
                                                String relationshipTypeGuid,
                                                int fromRelationshipElement,
                                                Date asOfTime,
                                                String sequencingProperty,
                                                SequencingOrder sequencingOrder,
                                                int pageSize)
                                         throws MetadataServerUncontactableException,
                                                UserNotAuthorizedException,
                                                InvalidParameterException,
                                                FunctionNotSupportedException,
                                                UnrecognizedGUIDException
```
Get the relationships associated with entity softwareServer represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the softwareServer

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getDeployedAPIById
```
public DeployedAPI getDeployedAPIById(String userId,
                                      String entityGuid)
                               throws MetadataServerUncontactableException,
                                      UserNotAuthorizedException,
                                      InvalidParameterException,
                                      UnrecognizedGUIDException
```
Fetch complete definition of an deployedAPI given its GUID. The limit and offset paging parameters limit the number elements returned in each of the deployedAPIs relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

DeployedAPI the DeployedAPI entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createDeployedAPI

public DeployedAPI createDeployedAPI(String userId,
                                     DeployedAPI deployedAPI)
                              throws MetadataServerUncontactableException,
                                     UserNotAuthorizedException,
                                     InvalidParameterException,
                                     ClassificationException,
                                     StatusNotSupportedException

Create new deployedAPI.

Parameters:: userId - user identity; deployedAPI - the input entity with values.
Returns:: DeployedAPI the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateDeployedAPI
```
public DeployedAPI updateDeployedAPI(String userId,
                                     DeployedAPI deployedAPI)
                              throws MetadataServerUncontactableException,
                                     UserNotAuthorizedException,
                                     InvalidParameterException,
                                     UnrecognizedGUIDException
```
Update deployedAPI

Parameters:

userId - user identity

deployedAPI - deployedAPI to update

Returns:

DeployedAPI the updated deployedAPI entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteDeployedAPIByGuid
```
public EntityDetail deleteDeployedAPIByGuid(String userId,
                                            String entityGuid)
                                     throws MetadataServerUncontactableException,
                                            UserNotAuthorizedException,
                                            FunctionNotSupportedException,
                                            InvalidParameterException,
                                            UnrecognizedGUIDException
```
Delete an deployedAPI identified by its GUID. Delete is a soft delete, this means that the deployedAPI has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the deployedAPI

Returns:

DeployedAPI the deleted DeployedAPI entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeDeployedAPIByGuid
```
public void purgeDeployedAPIByGuid(String userId,
                                   String entityGuid)
                            throws MetadataServerUncontactableException,
                                   UserNotAuthorizedException,
                                   InvalidParameterException,
                                   UnrecognizedGUIDException,
                                   EntityNotDeletedException,
                                   GUIDNotPurgedException
```
Purge an deployedAPI identified by its GUID. Delete is a hard delete, this means that the deployedAPI is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the deployedAPI

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreDeployedAPI
```
public DeployedAPI restoreDeployedAPI(String userId,
                                      String entityGuid)
                               throws MetadataServerUncontactableException,
                                      UserNotAuthorizedException,
                                      InvalidParameterException,
                                      UnrecognizedGUIDException,
                                      GUIDNotDeletedException,
                                      FunctionNotSupportedException
```
Restore an DeployedAPI identified by its GUID. Restore resurrects a soft deleted DeployedAPI. When a DeployedAPI was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the DeployedAPI

Returns:

DeployedAPI the restored DeployedAPI

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the DeployedAPI is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addDeployedAPIClassifications

public DeployedAPI addDeployedAPIClassifications(String userId,
                                                 String entityGuid,
                                                 List<Classification> classifications)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 ClassificationException,
                                                 UnrecognizedGUIDException

Add classifications to the supplied deployedAPI

Parameters:: userId - user identity; entityGuid - the GUID value for deployedAPI; classifications - the classifications to apply.
Returns:: the deployedAPI entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateDeployedAPIClassification

public DeployedAPI updateDeployedAPIClassification(String userId,
                                                   String entityGuid,
                                                   List<Classification> classificationsToUpdate)
                                            throws MetadataServerUncontactableException,
                                                   UserNotAuthorizedException,
                                                   InvalidParameterException,
                                                   ClassificationException,
                                                   UnrecognizedGUIDException

Updates classifications to an existing deployedAPI represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the deployedAPI; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given deployedAPI guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteDeployedAPIClassification

public DeployedAPI deleteDeployedAPIClassification(String userId,
                                                   String entityGuid,
                                                   String name)
                                            throws MetadataServerUncontactableException,
                                                   UserNotAuthorizedException,
                                                   InvalidParameterException,
                                                   ClassificationException,
                                                   UnrecognizedGUIDException

Deletes a given classification from an existing deployedAPI represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the deployedAPI; name - name of the classification
Returns:: deleted DeployedAPI classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getDeployedAPIRelationships
```
public Set<Line> getDeployedAPIRelationships(String userId,
                                             String entityGuid,
                                             String relationshipTypeGuid,
                                             int fromRelationshipElement,
                                             Date asOfTime,
                                             String sequencingProperty,
                                             SequencingOrder sequencingOrder,
                                             int pageSize)
                                      throws MetadataServerUncontactableException,
                                             UserNotAuthorizedException,
                                             InvalidParameterException,
                                             FunctionNotSupportedException,
                                             UnrecognizedGUIDException
```
Get the relationships associated with entity deployedAPI represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the deployedAPI

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getMediaFileById
```
public MediaFile getMediaFileById(String userId,
                                  String entityGuid)
                           throws MetadataServerUncontactableException,
                                  UserNotAuthorizedException,
                                  InvalidParameterException,
                                  UnrecognizedGUIDException
```
Fetch complete definition of an mediaFile given its GUID. The limit and offset paging parameters limit the number elements returned in each of the mediaFiles relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

MediaFile the MediaFile entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createMediaFile

public MediaFile createMediaFile(String userId,
                                 MediaFile mediaFile)
                          throws MetadataServerUncontactableException,
                                 UserNotAuthorizedException,
                                 InvalidParameterException,
                                 ClassificationException,
                                 StatusNotSupportedException

Create new mediaFile.

Parameters:: userId - user identity; mediaFile - the input entity with values.
Returns:: MediaFile the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateMediaFile
```
public MediaFile updateMediaFile(String userId,
                                 MediaFile mediaFile)
                          throws MetadataServerUncontactableException,
                                 UserNotAuthorizedException,
                                 InvalidParameterException,
                                 UnrecognizedGUIDException
```
Update mediaFile

Parameters:

userId - user identity

mediaFile - mediaFile to update

Returns:

MediaFile the updated mediaFile entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteMediaFileByGuid
```
public EntityDetail deleteMediaFileByGuid(String userId,
                                          String entityGuid)
                                   throws MetadataServerUncontactableException,
                                          UserNotAuthorizedException,
                                          FunctionNotSupportedException,
                                          InvalidParameterException,
                                          UnrecognizedGUIDException
```
Delete an mediaFile identified by its GUID. Delete is a soft delete, this means that the mediaFile has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the mediaFile

Returns:

MediaFile the deleted MediaFile entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeMediaFileByGuid
```
public void purgeMediaFileByGuid(String userId,
                                 String entityGuid)
                          throws MetadataServerUncontactableException,
                                 UserNotAuthorizedException,
                                 InvalidParameterException,
                                 UnrecognizedGUIDException,
                                 EntityNotDeletedException,
                                 GUIDNotPurgedException
```
Purge an mediaFile identified by its GUID. Delete is a hard delete, this means that the mediaFile is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the mediaFile

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreMediaFile
```
public MediaFile restoreMediaFile(String userId,
                                  String entityGuid)
                           throws MetadataServerUncontactableException,
                                  UserNotAuthorizedException,
                                  InvalidParameterException,
                                  UnrecognizedGUIDException,
                                  GUIDNotDeletedException,
                                  FunctionNotSupportedException
```
Restore an MediaFile identified by its GUID. Restore resurrects a soft deleted MediaFile. When a MediaFile was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the MediaFile

Returns:

MediaFile the restored MediaFile

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the MediaFile is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addMediaFileClassifications

public MediaFile addMediaFileClassifications(String userId,
                                             String entityGuid,
                                             List<Classification> classifications)
                                      throws MetadataServerUncontactableException,
                                             UserNotAuthorizedException,
                                             InvalidParameterException,
                                             ClassificationException,
                                             UnrecognizedGUIDException

Add classifications to the supplied mediaFile

Parameters:: userId - user identity; entityGuid - the GUID value for mediaFile; classifications - the classifications to apply.
Returns:: the mediaFile entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateMediaFileClassification

public MediaFile updateMediaFileClassification(String userId,
                                               String entityGuid,
                                               List<Classification> classificationsToUpdate)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               InvalidParameterException,
                                               ClassificationException,
                                               UnrecognizedGUIDException

Updates classifications to an existing mediaFile represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the mediaFile; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given mediaFile guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteMediaFileClassification

public MediaFile deleteMediaFileClassification(String userId,
                                               String entityGuid,
                                               String name)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               InvalidParameterException,
                                               ClassificationException,
                                               UnrecognizedGUIDException

Deletes a given classification from an existing mediaFile represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the mediaFile; name - name of the classification
Returns:: deleted MediaFile classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getMediaFileRelationships
```
public Set<Line> getMediaFileRelationships(String userId,
                                           String entityGuid,
                                           String relationshipTypeGuid,
                                           int fromRelationshipElement,
                                           Date asOfTime,
                                           String sequencingProperty,
                                           SequencingOrder sequencingOrder,
                                           int pageSize)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           InvalidParameterException,
                                           FunctionNotSupportedException,
                                           UnrecognizedGUIDException
```
Get the relationships associated with entity mediaFile represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the mediaFile

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getCommentById
```
public Comment getCommentById(String userId,
                              String entityGuid)
                       throws MetadataServerUncontactableException,
                              UserNotAuthorizedException,
                              InvalidParameterException,
                              UnrecognizedGUIDException
```
Fetch complete definition of an comment given its GUID. The limit and offset paging parameters limit the number elements returned in each of the comments relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

Comment the Comment entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createComment

public Comment createComment(String userId,
                             Comment comment)
                      throws MetadataServerUncontactableException,
                             UserNotAuthorizedException,
                             InvalidParameterException,
                             ClassificationException,
                             StatusNotSupportedException

Create new comment.

Parameters:: userId - user identity; comment - the input entity with values.
Returns:: Comment the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateComment
```
public Comment updateComment(String userId,
                             Comment comment)
                      throws MetadataServerUncontactableException,
                             UserNotAuthorizedException,
                             InvalidParameterException,
                             UnrecognizedGUIDException
```
Update comment

Parameters:

userId - user identity

comment - comment to update

Returns:

Comment the updated comment entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteCommentByGuid
```
public EntityDetail deleteCommentByGuid(String userId,
                                        String entityGuid)
                                 throws MetadataServerUncontactableException,
                                        UserNotAuthorizedException,
                                        FunctionNotSupportedException,
                                        InvalidParameterException,
                                        UnrecognizedGUIDException
```
Delete an comment identified by its GUID. Delete is a soft delete, this means that the comment has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the comment

Returns:

Comment the deleted Comment entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeCommentByGuid
```
public void purgeCommentByGuid(String userId,
                               String entityGuid)
                        throws MetadataServerUncontactableException,
                               UserNotAuthorizedException,
                               InvalidParameterException,
                               UnrecognizedGUIDException,
                               EntityNotDeletedException,
                               GUIDNotPurgedException
```
Purge an comment identified by its GUID. Delete is a hard delete, this means that the comment is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the comment

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreComment
```
public Comment restoreComment(String userId,
                              String entityGuid)
                       throws MetadataServerUncontactableException,
                              UserNotAuthorizedException,
                              InvalidParameterException,
                              UnrecognizedGUIDException,
                              GUIDNotDeletedException,
                              FunctionNotSupportedException
```
Restore an Comment identified by its GUID. Restore resurrects a soft deleted Comment. When a Comment was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the Comment

Returns:

Comment the restored Comment

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the Comment is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addCommentClassifications

public Comment addCommentClassifications(String userId,
                                         String entityGuid,
                                         List<Classification> classifications)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         InvalidParameterException,
                                         ClassificationException,
                                         UnrecognizedGUIDException

Add classifications to the supplied comment

Parameters:: userId - user identity; entityGuid - the GUID value for comment; classifications - the classifications to apply.
Returns:: the comment entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateCommentClassification

public Comment updateCommentClassification(String userId,
                                           String entityGuid,
                                           List<Classification> classificationsToUpdate)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           InvalidParameterException,
                                           ClassificationException,
                                           UnrecognizedGUIDException

Updates classifications to an existing comment represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the comment; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given comment guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteCommentClassification

public Comment deleteCommentClassification(String userId,
                                           String entityGuid,
                                           String name)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           InvalidParameterException,
                                           ClassificationException,
                                           UnrecognizedGUIDException

Deletes a given classification from an existing comment represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the comment; name - name of the classification
Returns:: deleted Comment classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getCommentRelationships
```
public Set<Line> getCommentRelationships(String userId,
                                         String entityGuid,
                                         String relationshipTypeGuid,
                                         int fromRelationshipElement,
                                         Date asOfTime,
                                         String sequencingProperty,
                                         SequencingOrder sequencingOrder,
                                         int pageSize)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         InvalidParameterException,
                                         FunctionNotSupportedException,
                                         UnrecognizedGUIDException
```
Get the relationships associated with entity comment represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the comment

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getRelatedMediaById
```
public RelatedMedia getRelatedMediaById(String userId,
                                        String entityGuid)
                                 throws MetadataServerUncontactableException,
                                        UserNotAuthorizedException,
                                        InvalidParameterException,
                                        UnrecognizedGUIDException
```
Fetch complete definition of an relatedMedia given its GUID. The limit and offset paging parameters limit the number elements returned in each of the relatedMedias relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

RelatedMedia the RelatedMedia entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createRelatedMedia

public RelatedMedia createRelatedMedia(String userId,
                                       RelatedMedia relatedMedia)
                                throws MetadataServerUncontactableException,
                                       UserNotAuthorizedException,
                                       InvalidParameterException,
                                       ClassificationException,
                                       StatusNotSupportedException

Create new relatedMedia.

Parameters:: userId - user identity; relatedMedia - the input entity with values.
Returns:: RelatedMedia the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateRelatedMedia
```
public RelatedMedia updateRelatedMedia(String userId,
                                       RelatedMedia relatedMedia)
                                throws MetadataServerUncontactableException,
                                       UserNotAuthorizedException,
                                       InvalidParameterException,
                                       UnrecognizedGUIDException
```
Update relatedMedia

Parameters:

userId - user identity

relatedMedia - relatedMedia to update

Returns:

RelatedMedia the updated relatedMedia entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteRelatedMediaByGuid
```
public EntityDetail deleteRelatedMediaByGuid(String userId,
                                             String entityGuid)
                                      throws MetadataServerUncontactableException,
                                             UserNotAuthorizedException,
                                             FunctionNotSupportedException,
                                             InvalidParameterException,
                                             UnrecognizedGUIDException
```
Delete an relatedMedia identified by its GUID. Delete is a soft delete, this means that the relatedMedia has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the relatedMedia

Returns:

RelatedMedia the deleted RelatedMedia entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeRelatedMediaByGuid
```
public void purgeRelatedMediaByGuid(String userId,
                                    String entityGuid)
                             throws MetadataServerUncontactableException,
                                    UserNotAuthorizedException,
                                    InvalidParameterException,
                                    UnrecognizedGUIDException,
                                    EntityNotDeletedException,
                                    GUIDNotPurgedException
```
Purge an relatedMedia identified by its GUID. Delete is a hard delete, this means that the relatedMedia is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the relatedMedia

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreRelatedMedia
```
public RelatedMedia restoreRelatedMedia(String userId,
                                        String entityGuid)
                                 throws MetadataServerUncontactableException,
                                        UserNotAuthorizedException,
                                        InvalidParameterException,
                                        UnrecognizedGUIDException,
                                        GUIDNotDeletedException,
                                        FunctionNotSupportedException
```
Restore an RelatedMedia identified by its GUID. Restore resurrects a soft deleted RelatedMedia. When a RelatedMedia was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the RelatedMedia

Returns:

RelatedMedia the restored RelatedMedia

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the RelatedMedia is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addRelatedMediaClassifications

public RelatedMedia addRelatedMediaClassifications(String userId,
                                                   String entityGuid,
                                                   List<Classification> classifications)
                                            throws MetadataServerUncontactableException,
                                                   UserNotAuthorizedException,
                                                   InvalidParameterException,
                                                   ClassificationException,
                                                   UnrecognizedGUIDException

Add classifications to the supplied relatedMedia

Parameters:: userId - user identity; entityGuid - the GUID value for relatedMedia; classifications - the classifications to apply.
Returns:: the relatedMedia entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateRelatedMediaClassification

public RelatedMedia updateRelatedMediaClassification(String userId,
                                                     String entityGuid,
                                                     List<Classification> classificationsToUpdate)
                                              throws MetadataServerUncontactableException,
                                                     UserNotAuthorizedException,
                                                     InvalidParameterException,
                                                     ClassificationException,
                                                     UnrecognizedGUIDException

Updates classifications to an existing relatedMedia represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the relatedMedia; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given relatedMedia guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteRelatedMediaClassification

public RelatedMedia deleteRelatedMediaClassification(String userId,
                                                     String entityGuid,
                                                     String name)
                                              throws MetadataServerUncontactableException,
                                                     UserNotAuthorizedException,
                                                     InvalidParameterException,
                                                     ClassificationException,
                                                     UnrecognizedGUIDException

Deletes a given classification from an existing relatedMedia represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the relatedMedia; name - name of the classification
Returns:: deleted RelatedMedia classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getRelatedMediaRelationships
```
public Set<Line> getRelatedMediaRelationships(String userId,
                                              String entityGuid,
                                              String relationshipTypeGuid,
                                              int fromRelationshipElement,
                                              Date asOfTime,
                                              String sequencingProperty,
                                              SequencingOrder sequencingOrder,
                                              int pageSize)
                                       throws MetadataServerUncontactableException,
                                              UserNotAuthorizedException,
                                              InvalidParameterException,
                                              FunctionNotSupportedException,
                                              UnrecognizedGUIDException
```
Get the relationships associated with entity relatedMedia represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the relatedMedia

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getConnectorTypeById
```
public ConnectorType getConnectorTypeById(String userId,
                                          String entityGuid)
                                   throws MetadataServerUncontactableException,
                                          UserNotAuthorizedException,
                                          InvalidParameterException,
                                          UnrecognizedGUIDException
```
Fetch complete definition of an connectorType given its GUID. The limit and offset paging parameters limit the number elements returned in each of the connectorTypes relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

ConnectorType the ConnectorType entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createConnectorType

public ConnectorType createConnectorType(String userId,
                                         ConnectorType connectorType)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         InvalidParameterException,
                                         ClassificationException,
                                         StatusNotSupportedException

Create new connectorType.

Parameters:: userId - user identity; connectorType - the input entity with values.
Returns:: ConnectorType the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateConnectorType
```
public ConnectorType updateConnectorType(String userId,
                                         ConnectorType connectorType)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         InvalidParameterException,
                                         UnrecognizedGUIDException
```
Update connectorType

Parameters:

userId - user identity

connectorType - connectorType to update

Returns:

ConnectorType the updated connectorType entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteConnectorTypeByGuid
```
public EntityDetail deleteConnectorTypeByGuid(String userId,
                                              String entityGuid)
                                       throws MetadataServerUncontactableException,
                                              UserNotAuthorizedException,
                                              FunctionNotSupportedException,
                                              InvalidParameterException,
                                              UnrecognizedGUIDException
```
Delete an connectorType identified by its GUID. Delete is a soft delete, this means that the connectorType has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the connectorType

Returns:

ConnectorType the deleted ConnectorType entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeConnectorTypeByGuid
```
public void purgeConnectorTypeByGuid(String userId,
                                     String entityGuid)
                              throws MetadataServerUncontactableException,
                                     UserNotAuthorizedException,
                                     InvalidParameterException,
                                     UnrecognizedGUIDException,
                                     EntityNotDeletedException,
                                     GUIDNotPurgedException
```
Purge an connectorType identified by its GUID. Delete is a hard delete, this means that the connectorType is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the connectorType

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreConnectorType
```
public ConnectorType restoreConnectorType(String userId,
                                          String entityGuid)
                                   throws MetadataServerUncontactableException,
                                          UserNotAuthorizedException,
                                          InvalidParameterException,
                                          UnrecognizedGUIDException,
                                          GUIDNotDeletedException,
                                          FunctionNotSupportedException
```
Restore an ConnectorType identified by its GUID. Restore resurrects a soft deleted ConnectorType. When a ConnectorType was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the ConnectorType

Returns:

ConnectorType the restored ConnectorType

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the ConnectorType is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addConnectorTypeClassifications

public ConnectorType addConnectorTypeClassifications(String userId,
                                                     String entityGuid,
                                                     List<Classification> classifications)
                                              throws MetadataServerUncontactableException,
                                                     UserNotAuthorizedException,
                                                     InvalidParameterException,
                                                     ClassificationException,
                                                     UnrecognizedGUIDException

Add classifications to the supplied connectorType

Parameters:: userId - user identity; entityGuid - the GUID value for connectorType; classifications - the classifications to apply.
Returns:: the connectorType entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateConnectorTypeClassification

public ConnectorType updateConnectorTypeClassification(String userId,
                                                       String entityGuid,
                                                       List<Classification> classificationsToUpdate)
                                                throws MetadataServerUncontactableException,
                                                       UserNotAuthorizedException,
                                                       InvalidParameterException,
                                                       ClassificationException,
                                                       UnrecognizedGUIDException

Updates classifications to an existing connectorType represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the connectorType; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given connectorType guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteConnectorTypeClassification

public ConnectorType deleteConnectorTypeClassification(String userId,
                                                       String entityGuid,
                                                       String name)
                                                throws MetadataServerUncontactableException,
                                                       UserNotAuthorizedException,
                                                       InvalidParameterException,
                                                       ClassificationException,
                                                       UnrecognizedGUIDException

Deletes a given classification from an existing connectorType represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the connectorType; name - name of the classification
Returns:: deleted ConnectorType classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getConnectorTypeRelationships
```
public Set<Line> getConnectorTypeRelationships(String userId,
                                               String entityGuid,
                                               String relationshipTypeGuid,
                                               int fromRelationshipElement,
                                               Date asOfTime,
                                               String sequencingProperty,
                                               SequencingOrder sequencingOrder,
                                               int pageSize)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               InvalidParameterException,
                                               FunctionNotSupportedException,
                                               UnrecognizedGUIDException
```
Get the relationships associated with entity connectorType represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the connectorType

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getCohortMemberById
```
public CohortMember getCohortMemberById(String userId,
                                        String entityGuid)
                                 throws MetadataServerUncontactableException,
                                        UserNotAuthorizedException,
                                        InvalidParameterException,
                                        UnrecognizedGUIDException
```
Fetch complete definition of an cohortMember given its GUID. The limit and offset paging parameters limit the number elements returned in each of the cohortMembers relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

CohortMember the CohortMember entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createCohortMember

public CohortMember createCohortMember(String userId,
                                       CohortMember cohortMember)
                                throws MetadataServerUncontactableException,
                                       UserNotAuthorizedException,
                                       InvalidParameterException,
                                       ClassificationException,
                                       StatusNotSupportedException

Create new cohortMember.

Parameters:: userId - user identity; cohortMember - the input entity with values.
Returns:: CohortMember the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateCohortMember
```
public CohortMember updateCohortMember(String userId,
                                       CohortMember cohortMember)
                                throws MetadataServerUncontactableException,
                                       UserNotAuthorizedException,
                                       InvalidParameterException,
                                       UnrecognizedGUIDException
```
Update cohortMember

Parameters:

userId - user identity

cohortMember - cohortMember to update

Returns:

CohortMember the updated cohortMember entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteCohortMemberByGuid
```
public EntityDetail deleteCohortMemberByGuid(String userId,
                                             String entityGuid)
                                      throws MetadataServerUncontactableException,
                                             UserNotAuthorizedException,
                                             FunctionNotSupportedException,
                                             InvalidParameterException,
                                             UnrecognizedGUIDException
```
Delete an cohortMember identified by its GUID. Delete is a soft delete, this means that the cohortMember has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the cohortMember

Returns:

CohortMember the deleted CohortMember entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeCohortMemberByGuid
```
public void purgeCohortMemberByGuid(String userId,
                                    String entityGuid)
                             throws MetadataServerUncontactableException,
                                    UserNotAuthorizedException,
                                    InvalidParameterException,
                                    UnrecognizedGUIDException,
                                    EntityNotDeletedException,
                                    GUIDNotPurgedException
```
Purge an cohortMember identified by its GUID. Delete is a hard delete, this means that the cohortMember is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the cohortMember

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreCohortMember
```
public CohortMember restoreCohortMember(String userId,
                                        String entityGuid)
                                 throws MetadataServerUncontactableException,
                                        UserNotAuthorizedException,
                                        InvalidParameterException,
                                        UnrecognizedGUIDException,
                                        GUIDNotDeletedException,
                                        FunctionNotSupportedException
```
Restore an CohortMember identified by its GUID. Restore resurrects a soft deleted CohortMember. When a CohortMember was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the CohortMember

Returns:

CohortMember the restored CohortMember

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the CohortMember is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addCohortMemberClassifications

public CohortMember addCohortMemberClassifications(String userId,
                                                   String entityGuid,
                                                   List<Classification> classifications)
                                            throws MetadataServerUncontactableException,
                                                   UserNotAuthorizedException,
                                                   InvalidParameterException,
                                                   ClassificationException,
                                                   UnrecognizedGUIDException

Add classifications to the supplied cohortMember

Parameters:: userId - user identity; entityGuid - the GUID value for cohortMember; classifications - the classifications to apply.
Returns:: the cohortMember entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateCohortMemberClassification

public CohortMember updateCohortMemberClassification(String userId,
                                                     String entityGuid,
                                                     List<Classification> classificationsToUpdate)
                                              throws MetadataServerUncontactableException,
                                                     UserNotAuthorizedException,
                                                     InvalidParameterException,
                                                     ClassificationException,
                                                     UnrecognizedGUIDException

Updates classifications to an existing cohortMember represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the cohortMember; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given cohortMember guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteCohortMemberClassification

public CohortMember deleteCohortMemberClassification(String userId,
                                                     String entityGuid,
                                                     String name)
                                              throws MetadataServerUncontactableException,
                                                     UserNotAuthorizedException,
                                                     InvalidParameterException,
                                                     ClassificationException,
                                                     UnrecognizedGUIDException

Deletes a given classification from an existing cohortMember represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the cohortMember; name - name of the classification
Returns:: deleted CohortMember classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getCohortMemberRelationships
```
public Set<Line> getCohortMemberRelationships(String userId,
                                              String entityGuid,
                                              String relationshipTypeGuid,
                                              int fromRelationshipElement,
                                              Date asOfTime,
                                              String sequencingProperty,
                                              SequencingOrder sequencingOrder,
                                              int pageSize)
                                       throws MetadataServerUncontactableException,
                                              UserNotAuthorizedException,
                                              InvalidParameterException,
                                              FunctionNotSupportedException,
                                              UnrecognizedGUIDException
```
Get the relationships associated with entity cohortMember represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the cohortMember

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getComplexSchemaTypeById
```
public ComplexSchemaType getComplexSchemaTypeById(String userId,
                                                  String entityGuid)
                                           throws MetadataServerUncontactableException,
                                                  UserNotAuthorizedException,
                                                  InvalidParameterException,
                                                  UnrecognizedGUIDException
```
Fetch complete definition of an complexSchemaType given its GUID. The limit and offset paging parameters limit the number elements returned in each of the complexSchemaTypes relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

ComplexSchemaType the ComplexSchemaType entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createComplexSchemaType

public ComplexSchemaType createComplexSchemaType(String userId,
                                                 ComplexSchemaType complexSchemaType)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 ClassificationException,
                                                 StatusNotSupportedException

Create new complexSchemaType.

Parameters:: userId - user identity; complexSchemaType - the input entity with values.
Returns:: ComplexSchemaType the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateComplexSchemaType

public ComplexSchemaType updateComplexSchemaType(String userId,
                                                 ComplexSchemaType complexSchemaType)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 UnrecognizedGUIDException

Update complexSchemaType

Parameters:: userId - user identity; complexSchemaType - complexSchemaType to update
Returns:: ComplexSchemaType the updated complexSchemaType entity
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteComplexSchemaTypeByGuid
```
public EntityDetail deleteComplexSchemaTypeByGuid(String userId,
                                                  String entityGuid)
                                           throws MetadataServerUncontactableException,
                                                  UserNotAuthorizedException,
                                                  FunctionNotSupportedException,
                                                  InvalidParameterException,
                                                  UnrecognizedGUIDException
```
Delete an complexSchemaType identified by its GUID. Delete is a soft delete, this means that the complexSchemaType has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the complexSchemaType

Returns:

ComplexSchemaType the deleted ComplexSchemaType entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeComplexSchemaTypeByGuid
```
public void purgeComplexSchemaTypeByGuid(String userId,
                                         String entityGuid)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         InvalidParameterException,
                                         UnrecognizedGUIDException,
                                         EntityNotDeletedException,
                                         GUIDNotPurgedException
```
Purge an complexSchemaType identified by its GUID. Delete is a hard delete, this means that the complexSchemaType is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the complexSchemaType

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreComplexSchemaType
```
public ComplexSchemaType restoreComplexSchemaType(String userId,
                                                  String entityGuid)
                                           throws MetadataServerUncontactableException,
                                                  UserNotAuthorizedException,
                                                  InvalidParameterException,
                                                  UnrecognizedGUIDException,
                                                  GUIDNotDeletedException,
                                                  FunctionNotSupportedException
```
Restore an ComplexSchemaType identified by its GUID. Restore resurrects a soft deleted ComplexSchemaType. When a ComplexSchemaType was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the ComplexSchemaType

Returns:

ComplexSchemaType the restored ComplexSchemaType

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the ComplexSchemaType is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addComplexSchemaTypeClassifications

public ComplexSchemaType addComplexSchemaTypeClassifications(String userId,
                                                             String entityGuid,
                                                             List<Classification> classifications)
                                                      throws MetadataServerUncontactableException,
                                                             UserNotAuthorizedException,
                                                             InvalidParameterException,
                                                             ClassificationException,
                                                             UnrecognizedGUIDException

Add classifications to the supplied complexSchemaType

Parameters:: userId - user identity; entityGuid - the GUID value for complexSchemaType; classifications - the classifications to apply.
Returns:: the complexSchemaType entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateComplexSchemaTypeClassification

public ComplexSchemaType updateComplexSchemaTypeClassification(String userId,
                                                               String entityGuid,
                                                               List<Classification> classificationsToUpdate)
                                                        throws MetadataServerUncontactableException,
                                                               UserNotAuthorizedException,
                                                               InvalidParameterException,
                                                               ClassificationException,
                                                               UnrecognizedGUIDException

Updates classifications to an existing complexSchemaType represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the complexSchemaType; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given complexSchemaType guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteComplexSchemaTypeClassification

public ComplexSchemaType deleteComplexSchemaTypeClassification(String userId,
                                                               String entityGuid,
                                                               String name)
                                                        throws MetadataServerUncontactableException,
                                                               UserNotAuthorizedException,
                                                               InvalidParameterException,
                                                               ClassificationException,
                                                               UnrecognizedGUIDException

Deletes a given classification from an existing complexSchemaType represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the complexSchemaType; name - name of the classification
Returns:: deleted ComplexSchemaType classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getComplexSchemaTypeRelationships
```
public Set<Line> getComplexSchemaTypeRelationships(String userId,
                                                   String entityGuid,
                                                   String relationshipTypeGuid,
                                                   int fromRelationshipElement,
                                                   Date asOfTime,
                                                   String sequencingProperty,
                                                   SequencingOrder sequencingOrder,
                                                   int pageSize)
                                            throws MetadataServerUncontactableException,
                                                   UserNotAuthorizedException,
                                                   InvalidParameterException,
                                                   FunctionNotSupportedException,
                                                   UnrecognizedGUIDException
```
Get the relationships associated with entity complexSchemaType represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the complexSchemaType

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getGovernanceMetricById
```
public GovernanceMetric getGovernanceMetricById(String userId,
                                                String entityGuid)
                                         throws MetadataServerUncontactableException,
                                                UserNotAuthorizedException,
                                                InvalidParameterException,
                                                UnrecognizedGUIDException
```
Fetch complete definition of an governanceMetric given its GUID. The limit and offset paging parameters limit the number elements returned in each of the governanceMetrics relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

GovernanceMetric the GovernanceMetric entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createGovernanceMetric

public GovernanceMetric createGovernanceMetric(String userId,
                                               GovernanceMetric governanceMetric)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               InvalidParameterException,
                                               ClassificationException,
                                               StatusNotSupportedException

Create new governanceMetric.

Parameters:: userId - user identity; governanceMetric - the input entity with values.
Returns:: GovernanceMetric the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateGovernanceMetric

public GovernanceMetric updateGovernanceMetric(String userId,
                                               GovernanceMetric governanceMetric)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               InvalidParameterException,
                                               UnrecognizedGUIDException

Update governanceMetric

Parameters:: userId - user identity; governanceMetric - governanceMetric to update
Returns:: GovernanceMetric the updated governanceMetric entity
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteGovernanceMetricByGuid
```
public EntityDetail deleteGovernanceMetricByGuid(String userId,
                                                 String entityGuid)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 FunctionNotSupportedException,
                                                 InvalidParameterException,
                                                 UnrecognizedGUIDException
```
Delete an governanceMetric identified by its GUID. Delete is a soft delete, this means that the governanceMetric has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the governanceMetric

Returns:

GovernanceMetric the deleted GovernanceMetric entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeGovernanceMetricByGuid
```
public void purgeGovernanceMetricByGuid(String userId,
                                        String entityGuid)
                                 throws MetadataServerUncontactableException,
                                        UserNotAuthorizedException,
                                        InvalidParameterException,
                                        UnrecognizedGUIDException,
                                        EntityNotDeletedException,
                                        GUIDNotPurgedException
```
Purge an governanceMetric identified by its GUID. Delete is a hard delete, this means that the governanceMetric is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the governanceMetric

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreGovernanceMetric
```
public GovernanceMetric restoreGovernanceMetric(String userId,
                                                String entityGuid)
                                         throws MetadataServerUncontactableException,
                                                UserNotAuthorizedException,
                                                InvalidParameterException,
                                                UnrecognizedGUIDException,
                                                GUIDNotDeletedException,
                                                FunctionNotSupportedException
```
Restore an GovernanceMetric identified by its GUID. Restore resurrects a soft deleted GovernanceMetric. When a GovernanceMetric was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the GovernanceMetric

Returns:

GovernanceMetric the restored GovernanceMetric

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the GovernanceMetric is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addGovernanceMetricClassifications

public GovernanceMetric addGovernanceMetricClassifications(String userId,
                                                           String entityGuid,
                                                           List<Classification> classifications)
                                                    throws MetadataServerUncontactableException,
                                                           UserNotAuthorizedException,
                                                           InvalidParameterException,
                                                           ClassificationException,
                                                           UnrecognizedGUIDException

Add classifications to the supplied governanceMetric

Parameters:: userId - user identity; entityGuid - the GUID value for governanceMetric; classifications - the classifications to apply.
Returns:: the governanceMetric entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateGovernanceMetricClassification

public GovernanceMetric updateGovernanceMetricClassification(String userId,
                                                             String entityGuid,
                                                             List<Classification> classificationsToUpdate)
                                                      throws MetadataServerUncontactableException,
                                                             UserNotAuthorizedException,
                                                             InvalidParameterException,
                                                             ClassificationException,
                                                             UnrecognizedGUIDException

Updates classifications to an existing governanceMetric represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the governanceMetric; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given governanceMetric guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteGovernanceMetricClassification

public GovernanceMetric deleteGovernanceMetricClassification(String userId,
                                                             String entityGuid,
                                                             String name)
                                                      throws MetadataServerUncontactableException,
                                                             UserNotAuthorizedException,
                                                             InvalidParameterException,
                                                             ClassificationException,
                                                             UnrecognizedGUIDException

Deletes a given classification from an existing governanceMetric represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the governanceMetric; name - name of the classification
Returns:: deleted GovernanceMetric classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getGovernanceMetricRelationships
```
public Set<Line> getGovernanceMetricRelationships(String userId,
                                                  String entityGuid,
                                                  String relationshipTypeGuid,
                                                  int fromRelationshipElement,
                                                  Date asOfTime,
                                                  String sequencingProperty,
                                                  SequencingOrder sequencingOrder,
                                                  int pageSize)
                                           throws MetadataServerUncontactableException,
                                                  UserNotAuthorizedException,
                                                  InvalidParameterException,
                                                  FunctionNotSupportedException,
                                                  UnrecognizedGUIDException
```
Get the relationships associated with entity governanceMetric represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the governanceMetric

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getExternalIdById
```
public ExternalId getExternalIdById(String userId,
                                    String entityGuid)
                             throws MetadataServerUncontactableException,
                                    UserNotAuthorizedException,
                                    InvalidParameterException,
                                    UnrecognizedGUIDException
```
Fetch complete definition of an externalId given its GUID. The limit and offset paging parameters limit the number elements returned in each of the externalIds relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

ExternalId the ExternalId entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createExternalId

public ExternalId createExternalId(String userId,
                                   ExternalId externalId)
                            throws MetadataServerUncontactableException,
                                   UserNotAuthorizedException,
                                   InvalidParameterException,
                                   ClassificationException,
                                   StatusNotSupportedException

Create new externalId.

Parameters:: userId - user identity; externalId - the input entity with values.
Returns:: ExternalId the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateExternalId
```
public ExternalId updateExternalId(String userId,
                                   ExternalId externalId)
                            throws MetadataServerUncontactableException,
                                   UserNotAuthorizedException,
                                   InvalidParameterException,
                                   UnrecognizedGUIDException
```
Update externalId

Parameters:

userId - user identity

externalId - externalId to update

Returns:

ExternalId the updated externalId entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteExternalIdByGuid
```
public EntityDetail deleteExternalIdByGuid(String userId,
                                           String entityGuid)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           FunctionNotSupportedException,
                                           InvalidParameterException,
                                           UnrecognizedGUIDException
```
Delete an externalId identified by its GUID. Delete is a soft delete, this means that the externalId has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the externalId

Returns:

ExternalId the deleted ExternalId entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeExternalIdByGuid
```
public void purgeExternalIdByGuid(String userId,
                                  String entityGuid)
                           throws MetadataServerUncontactableException,
                                  UserNotAuthorizedException,
                                  InvalidParameterException,
                                  UnrecognizedGUIDException,
                                  EntityNotDeletedException,
                                  GUIDNotPurgedException
```
Purge an externalId identified by its GUID. Delete is a hard delete, this means that the externalId is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the externalId

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreExternalId
```
public ExternalId restoreExternalId(String userId,
                                    String entityGuid)
                             throws MetadataServerUncontactableException,
                                    UserNotAuthorizedException,
                                    InvalidParameterException,
                                    UnrecognizedGUIDException,
                                    GUIDNotDeletedException,
                                    FunctionNotSupportedException
```
Restore an ExternalId identified by its GUID. Restore resurrects a soft deleted ExternalId. When a ExternalId was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the ExternalId

Returns:

ExternalId the restored ExternalId

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the ExternalId is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addExternalIdClassifications

public ExternalId addExternalIdClassifications(String userId,
                                               String entityGuid,
                                               List<Classification> classifications)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               InvalidParameterException,
                                               ClassificationException,
                                               UnrecognizedGUIDException

Add classifications to the supplied externalId

Parameters:: userId - user identity; entityGuid - the GUID value for externalId; classifications - the classifications to apply.
Returns:: the externalId entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateExternalIdClassification

public ExternalId updateExternalIdClassification(String userId,
                                                 String entityGuid,
                                                 List<Classification> classificationsToUpdate)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 ClassificationException,
                                                 UnrecognizedGUIDException

Updates classifications to an existing externalId represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the externalId; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given externalId guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteExternalIdClassification

public ExternalId deleteExternalIdClassification(String userId,
                                                 String entityGuid,
                                                 String name)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 ClassificationException,
                                                 UnrecognizedGUIDException

Deletes a given classification from an existing externalId represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the externalId; name - name of the classification
Returns:: deleted ExternalId classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getExternalIdRelationships
```
public Set<Line> getExternalIdRelationships(String userId,
                                            String entityGuid,
                                            String relationshipTypeGuid,
                                            int fromRelationshipElement,
                                            Date asOfTime,
                                            String sequencingProperty,
                                            SequencingOrder sequencingOrder,
                                            int pageSize)
                                     throws MetadataServerUncontactableException,
                                            UserNotAuthorizedException,
                                            InvalidParameterException,
                                            FunctionNotSupportedException,
                                            UnrecognizedGUIDException
```
Get the relationships associated with entity externalId represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the externalId

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getConnectionById
```
public Connection getConnectionById(String userId,
                                    String entityGuid)
                             throws MetadataServerUncontactableException,
                                    UserNotAuthorizedException,
                                    InvalidParameterException,
                                    UnrecognizedGUIDException
```
Fetch complete definition of an connection given its GUID. The limit and offset paging parameters limit the number elements returned in each of the connections relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

Connection the Connection entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createConnection

public Connection createConnection(String userId,
                                   Connection connection)
                            throws MetadataServerUncontactableException,
                                   UserNotAuthorizedException,
                                   InvalidParameterException,
                                   ClassificationException,
                                   StatusNotSupportedException

Create new connection.

Parameters:: userId - user identity; connection - the input entity with values.
Returns:: Connection the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateConnection
```
public Connection updateConnection(String userId,
                                   Connection connection)
                            throws MetadataServerUncontactableException,
                                   UserNotAuthorizedException,
                                   InvalidParameterException,
                                   UnrecognizedGUIDException
```
Update connection

Parameters:

userId - user identity

connection - connection to update

Returns:

Connection the updated connection entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteConnectionByGuid
```
public EntityDetail deleteConnectionByGuid(String userId,
                                           String entityGuid)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           FunctionNotSupportedException,
                                           InvalidParameterException,
                                           UnrecognizedGUIDException
```
Delete an connection identified by its GUID. Delete is a soft delete, this means that the connection has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the connection

Returns:

Connection the deleted Connection entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeConnectionByGuid
```
public void purgeConnectionByGuid(String userId,
                                  String entityGuid)
                           throws MetadataServerUncontactableException,
                                  UserNotAuthorizedException,
                                  InvalidParameterException,
                                  UnrecognizedGUIDException,
                                  EntityNotDeletedException,
                                  GUIDNotPurgedException
```
Purge an connection identified by its GUID. Delete is a hard delete, this means that the connection is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the connection

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreConnection
```
public Connection restoreConnection(String userId,
                                    String entityGuid)
                             throws MetadataServerUncontactableException,
                                    UserNotAuthorizedException,
                                    InvalidParameterException,
                                    UnrecognizedGUIDException,
                                    GUIDNotDeletedException,
                                    FunctionNotSupportedException
```
Restore an Connection identified by its GUID. Restore resurrects a soft deleted Connection. When a Connection was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the Connection

Returns:

Connection the restored Connection

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the Connection is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addConnectionClassifications

public Connection addConnectionClassifications(String userId,
                                               String entityGuid,
                                               List<Classification> classifications)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               InvalidParameterException,
                                               ClassificationException,
                                               UnrecognizedGUIDException

Add classifications to the supplied connection

Parameters:: userId - user identity; entityGuid - the GUID value for connection; classifications - the classifications to apply.
Returns:: the connection entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateConnectionClassification

public Connection updateConnectionClassification(String userId,
                                                 String entityGuid,
                                                 List<Classification> classificationsToUpdate)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 ClassificationException,
                                                 UnrecognizedGUIDException

Updates classifications to an existing connection represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the connection; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given connection guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteConnectionClassification

public Connection deleteConnectionClassification(String userId,
                                                 String entityGuid,
                                                 String name)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 ClassificationException,
                                                 UnrecognizedGUIDException

Deletes a given classification from an existing connection represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the connection; name - name of the classification
Returns:: deleted Connection classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getConnectionRelationships
```
public Set<Line> getConnectionRelationships(String userId,
                                            String entityGuid,
                                            String relationshipTypeGuid,
                                            int fromRelationshipElement,
                                            Date asOfTime,
                                            String sequencingProperty,
                                            SequencingOrder sequencingOrder,
                                            int pageSize)
                                     throws MetadataServerUncontactableException,
                                            UserNotAuthorizedException,
                                            InvalidParameterException,
                                            FunctionNotSupportedException,
                                            UnrecognizedGUIDException
```
Get the relationships associated with entity connection represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the connection

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getHostById
```
public Host getHostById(String userId,
                        String entityGuid)
                 throws MetadataServerUncontactableException,
                        UserNotAuthorizedException,
                        InvalidParameterException,
                        UnrecognizedGUIDException
```
Fetch complete definition of an host given its GUID. The limit and offset paging parameters limit the number elements returned in each of the hosts relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

Host the Host entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createHost
```
public Host createHost(String userId,
                       Host host)
                throws MetadataServerUncontactableException,
                       UserNotAuthorizedException,
                       InvalidParameterException,
                       ClassificationException,
                       StatusNotSupportedException
```
Create new host.

Parameters:

userId - user identity

host - the input entity with values.

Returns:

Host the created entity.

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

ClassificationException - a classification does not match constraints.

StatusNotSupportedException - status is not supported

updateHost
```
public Host updateHost(String userId,
                       Host host)
                throws MetadataServerUncontactableException,
                       UserNotAuthorizedException,
                       InvalidParameterException,
                       UnrecognizedGUIDException
```
Update host

Parameters:

userId - user identity

host - host to update

Returns:

Host the updated host entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteHostByGuid
```
public EntityDetail deleteHostByGuid(String userId,
                                     String entityGuid)
                              throws MetadataServerUncontactableException,
                                     UserNotAuthorizedException,
                                     FunctionNotSupportedException,
                                     InvalidParameterException,
                                     UnrecognizedGUIDException
```
Delete an host identified by its GUID. Delete is a soft delete, this means that the host has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the host

Returns:

Host the deleted Host entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeHostByGuid
```
public void purgeHostByGuid(String userId,
                            String entityGuid)
                     throws MetadataServerUncontactableException,
                            UserNotAuthorizedException,
                            InvalidParameterException,
                            UnrecognizedGUIDException,
                            EntityNotDeletedException,
                            GUIDNotPurgedException
```
Purge an host identified by its GUID. Delete is a hard delete, this means that the host is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the host

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreHost
```
public Host restoreHost(String userId,
                        String entityGuid)
                 throws MetadataServerUncontactableException,
                        UserNotAuthorizedException,
                        InvalidParameterException,
                        UnrecognizedGUIDException,
                        GUIDNotDeletedException,
                        FunctionNotSupportedException
```
Restore an Host identified by its GUID. Restore resurrects a soft deleted Host. When a Host was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the Host

Returns:

Host the restored Host

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the Host is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addHostClassifications

public Host addHostClassifications(String userId,
                                   String entityGuid,
                                   List<Classification> classifications)
                            throws MetadataServerUncontactableException,
                                   UserNotAuthorizedException,
                                   InvalidParameterException,
                                   ClassificationException,
                                   UnrecognizedGUIDException

Add classifications to the supplied host

Parameters:: userId - user identity; entityGuid - the GUID value for host; classifications - the classifications to apply.
Returns:: the host entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateHostClassification
```
public Host updateHostClassification(String userId,
                                     String entityGuid,
                                     List<Classification> classificationsToUpdate)
                              throws MetadataServerUncontactableException,
                                     UserNotAuthorizedException,
                                     InvalidParameterException,
                                     ClassificationException,
                                     UnrecognizedGUIDException
```
Updates classifications to an existing host represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the host

classificationsToUpdate - List of classifications to update entity with

Returns:

classification for the given host guid

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

ClassificationException - a classification does not match constraints.

deleteHostClassification
```
public Host deleteHostClassification(String userId,
                                     String entityGuid,
                                     String name)
                              throws MetadataServerUncontactableException,
                                     UserNotAuthorizedException,
                                     InvalidParameterException,
                                     ClassificationException,
                                     UnrecognizedGUIDException
```
Deletes a given classification from an existing host represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the host

name - name of the classification

Returns:

deleted Host classification

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

ClassificationException - a classification does not match constraints.

getHostRelationships
```
public Set<Line> getHostRelationships(String userId,
                                      String entityGuid,
                                      String relationshipTypeGuid,
                                      int fromRelationshipElement,
                                      Date asOfTime,
                                      String sequencingProperty,
                                      SequencingOrder sequencingOrder,
                                      int pageSize)
                               throws MetadataServerUncontactableException,
                                      UserNotAuthorizedException,
                                      InvalidParameterException,
                                      FunctionNotSupportedException,
                                      UnrecognizedGUIDException
```
Get the relationships associated with entity host represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the host

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getSubscriberListById
```
public SubscriberList getSubscriberListById(String userId,
                                            String entityGuid)
                                     throws MetadataServerUncontactableException,
                                            UserNotAuthorizedException,
                                            InvalidParameterException,
                                            UnrecognizedGUIDException
```
Fetch complete definition of an subscriberList given its GUID. The limit and offset paging parameters limit the number elements returned in each of the subscriberLists relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

SubscriberList the SubscriberList entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createSubscriberList

public SubscriberList createSubscriberList(String userId,
                                           SubscriberList subscriberList)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           InvalidParameterException,
                                           ClassificationException,
                                           StatusNotSupportedException

Create new subscriberList.

Parameters:: userId - user identity; subscriberList - the input entity with values.
Returns:: SubscriberList the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateSubscriberList

public SubscriberList updateSubscriberList(String userId,
                                           SubscriberList subscriberList)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           InvalidParameterException,
                                           UnrecognizedGUIDException

Update subscriberList

Parameters:: userId - user identity; subscriberList - subscriberList to update
Returns:: SubscriberList the updated subscriberList entity
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteSubscriberListByGuid
```
public EntityDetail deleteSubscriberListByGuid(String userId,
                                               String entityGuid)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               FunctionNotSupportedException,
                                               InvalidParameterException,
                                               UnrecognizedGUIDException
```
Delete an subscriberList identified by its GUID. Delete is a soft delete, this means that the subscriberList has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the subscriberList

Returns:

SubscriberList the deleted SubscriberList entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeSubscriberListByGuid
```
public void purgeSubscriberListByGuid(String userId,
                                      String entityGuid)
                               throws MetadataServerUncontactableException,
                                      UserNotAuthorizedException,
                                      InvalidParameterException,
                                      UnrecognizedGUIDException,
                                      EntityNotDeletedException,
                                      GUIDNotPurgedException
```
Purge an subscriberList identified by its GUID. Delete is a hard delete, this means that the subscriberList is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the subscriberList

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreSubscriberList
```
public SubscriberList restoreSubscriberList(String userId,
                                            String entityGuid)
                                     throws MetadataServerUncontactableException,
                                            UserNotAuthorizedException,
                                            InvalidParameterException,
                                            UnrecognizedGUIDException,
                                            GUIDNotDeletedException,
                                            FunctionNotSupportedException
```
Restore an SubscriberList identified by its GUID. Restore resurrects a soft deleted SubscriberList. When a SubscriberList was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the SubscriberList

Returns:

SubscriberList the restored SubscriberList

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the SubscriberList is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addSubscriberListClassifications

public SubscriberList addSubscriberListClassifications(String userId,
                                                       String entityGuid,
                                                       List<Classification> classifications)
                                                throws MetadataServerUncontactableException,
                                                       UserNotAuthorizedException,
                                                       InvalidParameterException,
                                                       ClassificationException,
                                                       UnrecognizedGUIDException

Add classifications to the supplied subscriberList

Parameters:: userId - user identity; entityGuid - the GUID value for subscriberList; classifications - the classifications to apply.
Returns:: the subscriberList entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateSubscriberListClassification

public SubscriberList updateSubscriberListClassification(String userId,
                                                         String entityGuid,
                                                         List<Classification> classificationsToUpdate)
                                                  throws MetadataServerUncontactableException,
                                                         UserNotAuthorizedException,
                                                         InvalidParameterException,
                                                         ClassificationException,
                                                         UnrecognizedGUIDException

Updates classifications to an existing subscriberList represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the subscriberList; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given subscriberList guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteSubscriberListClassification

public SubscriberList deleteSubscriberListClassification(String userId,
                                                         String entityGuid,
                                                         String name)
                                                  throws MetadataServerUncontactableException,
                                                         UserNotAuthorizedException,
                                                         InvalidParameterException,
                                                         ClassificationException,
                                                         UnrecognizedGUIDException

Deletes a given classification from an existing subscriberList represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the subscriberList; name - name of the classification
Returns:: deleted SubscriberList classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getSubscriberListRelationships
```
public Set<Line> getSubscriberListRelationships(String userId,
                                                String entityGuid,
                                                String relationshipTypeGuid,
                                                int fromRelationshipElement,
                                                Date asOfTime,
                                                String sequencingProperty,
                                                SequencingOrder sequencingOrder,
                                                int pageSize)
                                         throws MetadataServerUncontactableException,
                                                UserNotAuthorizedException,
                                                InvalidParameterException,
                                                FunctionNotSupportedException,
                                                UnrecognizedGUIDException
```
Get the relationships associated with entity subscriberList represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the subscriberList

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getCommunityMemberById
```
public CommunityMember getCommunityMemberById(String userId,
                                              String entityGuid)
                                       throws MetadataServerUncontactableException,
                                              UserNotAuthorizedException,
                                              InvalidParameterException,
                                              UnrecognizedGUIDException
```
Fetch complete definition of an communityMember given its GUID. The limit and offset paging parameters limit the number elements returned in each of the communityMembers relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

CommunityMember the CommunityMember entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createCommunityMember

public CommunityMember createCommunityMember(String userId,
                                             CommunityMember communityMember)
                                      throws MetadataServerUncontactableException,
                                             UserNotAuthorizedException,
                                             InvalidParameterException,
                                             ClassificationException,
                                             StatusNotSupportedException

Create new communityMember.

Parameters:: userId - user identity; communityMember - the input entity with values.
Returns:: CommunityMember the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateCommunityMember

public CommunityMember updateCommunityMember(String userId,
                                             CommunityMember communityMember)
                                      throws MetadataServerUncontactableException,
                                             UserNotAuthorizedException,
                                             InvalidParameterException,
                                             UnrecognizedGUIDException

Update communityMember

Parameters:: userId - user identity; communityMember - communityMember to update
Returns:: CommunityMember the updated communityMember entity
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteCommunityMemberByGuid
```
public EntityDetail deleteCommunityMemberByGuid(String userId,
                                                String entityGuid)
                                         throws MetadataServerUncontactableException,
                                                UserNotAuthorizedException,
                                                FunctionNotSupportedException,
                                                InvalidParameterException,
                                                UnrecognizedGUIDException
```
Delete an communityMember identified by its GUID. Delete is a soft delete, this means that the communityMember has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the communityMember

Returns:

CommunityMember the deleted CommunityMember entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeCommunityMemberByGuid
```
public void purgeCommunityMemberByGuid(String userId,
                                       String entityGuid)
                                throws MetadataServerUncontactableException,
                                       UserNotAuthorizedException,
                                       InvalidParameterException,
                                       UnrecognizedGUIDException,
                                       EntityNotDeletedException,
                                       GUIDNotPurgedException
```
Purge an communityMember identified by its GUID. Delete is a hard delete, this means that the communityMember is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the communityMember

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreCommunityMember
```
public CommunityMember restoreCommunityMember(String userId,
                                              String entityGuid)
                                       throws MetadataServerUncontactableException,
                                              UserNotAuthorizedException,
                                              InvalidParameterException,
                                              UnrecognizedGUIDException,
                                              GUIDNotDeletedException,
                                              FunctionNotSupportedException
```
Restore an CommunityMember identified by its GUID. Restore resurrects a soft deleted CommunityMember. When a CommunityMember was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the CommunityMember

Returns:

CommunityMember the restored CommunityMember

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the CommunityMember is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addCommunityMemberClassifications

public CommunityMember addCommunityMemberClassifications(String userId,
                                                         String entityGuid,
                                                         List<Classification> classifications)
                                                  throws MetadataServerUncontactableException,
                                                         UserNotAuthorizedException,
                                                         InvalidParameterException,
                                                         ClassificationException,
                                                         UnrecognizedGUIDException

Add classifications to the supplied communityMember

Parameters:: userId - user identity; entityGuid - the GUID value for communityMember; classifications - the classifications to apply.
Returns:: the communityMember entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateCommunityMemberClassification

public CommunityMember updateCommunityMemberClassification(String userId,
                                                           String entityGuid,
                                                           List<Classification> classificationsToUpdate)
                                                    throws MetadataServerUncontactableException,
                                                           UserNotAuthorizedException,
                                                           InvalidParameterException,
                                                           ClassificationException,
                                                           UnrecognizedGUIDException

Updates classifications to an existing communityMember represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the communityMember; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given communityMember guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteCommunityMemberClassification

public CommunityMember deleteCommunityMemberClassification(String userId,
                                                           String entityGuid,
                                                           String name)
                                                    throws MetadataServerUncontactableException,
                                                           UserNotAuthorizedException,
                                                           InvalidParameterException,
                                                           ClassificationException,
                                                           UnrecognizedGUIDException

Deletes a given classification from an existing communityMember represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the communityMember; name - name of the classification
Returns:: deleted CommunityMember classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getCommunityMemberRelationships
```
public Set<Line> getCommunityMemberRelationships(String userId,
                                                 String entityGuid,
                                                 String relationshipTypeGuid,
                                                 int fromRelationshipElement,
                                                 Date asOfTime,
                                                 String sequencingProperty,
                                                 SequencingOrder sequencingOrder,
                                                 int pageSize)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 FunctionNotSupportedException,
                                                 UnrecognizedGUIDException
```
Get the relationships associated with entity communityMember represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the communityMember

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getGovernanceRuleById
```
public GovernanceRule getGovernanceRuleById(String userId,
                                            String entityGuid)
                                     throws MetadataServerUncontactableException,
                                            UserNotAuthorizedException,
                                            InvalidParameterException,
                                            UnrecognizedGUIDException
```
Fetch complete definition of an governanceRule given its GUID. The limit and offset paging parameters limit the number elements returned in each of the governanceRules relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

GovernanceRule the GovernanceRule entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createGovernanceRule

public GovernanceRule createGovernanceRule(String userId,
                                           GovernanceRule governanceRule)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           InvalidParameterException,
                                           ClassificationException,
                                           StatusNotSupportedException

Create new governanceRule.

Parameters:: userId - user identity; governanceRule - the input entity with values.
Returns:: GovernanceRule the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateGovernanceRule

public GovernanceRule updateGovernanceRule(String userId,
                                           GovernanceRule governanceRule)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           InvalidParameterException,
                                           UnrecognizedGUIDException

Update governanceRule

Parameters:: userId - user identity; governanceRule - governanceRule to update
Returns:: GovernanceRule the updated governanceRule entity
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteGovernanceRuleByGuid
```
public EntityDetail deleteGovernanceRuleByGuid(String userId,
                                               String entityGuid)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               FunctionNotSupportedException,
                                               InvalidParameterException,
                                               UnrecognizedGUIDException
```
Delete an governanceRule identified by its GUID. Delete is a soft delete, this means that the governanceRule has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the governanceRule

Returns:

GovernanceRule the deleted GovernanceRule entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeGovernanceRuleByGuid
```
public void purgeGovernanceRuleByGuid(String userId,
                                      String entityGuid)
                               throws MetadataServerUncontactableException,
                                      UserNotAuthorizedException,
                                      InvalidParameterException,
                                      UnrecognizedGUIDException,
                                      EntityNotDeletedException,
                                      GUIDNotPurgedException
```
Purge an governanceRule identified by its GUID. Delete is a hard delete, this means that the governanceRule is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the governanceRule

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreGovernanceRule
```
public GovernanceRule restoreGovernanceRule(String userId,
                                            String entityGuid)
                                     throws MetadataServerUncontactableException,
                                            UserNotAuthorizedException,
                                            InvalidParameterException,
                                            UnrecognizedGUIDException,
                                            GUIDNotDeletedException,
                                            FunctionNotSupportedException
```
Restore an GovernanceRule identified by its GUID. Restore resurrects a soft deleted GovernanceRule. When a GovernanceRule was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the GovernanceRule

Returns:

GovernanceRule the restored GovernanceRule

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the GovernanceRule is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addGovernanceRuleClassifications

public GovernanceRule addGovernanceRuleClassifications(String userId,
                                                       String entityGuid,
                                                       List<Classification> classifications)
                                                throws MetadataServerUncontactableException,
                                                       UserNotAuthorizedException,
                                                       InvalidParameterException,
                                                       ClassificationException,
                                                       UnrecognizedGUIDException

Add classifications to the supplied governanceRule

Parameters:: userId - user identity; entityGuid - the GUID value for governanceRule; classifications - the classifications to apply.
Returns:: the governanceRule entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateGovernanceRuleClassification

public GovernanceRule updateGovernanceRuleClassification(String userId,
                                                         String entityGuid,
                                                         List<Classification> classificationsToUpdate)
                                                  throws MetadataServerUncontactableException,
                                                         UserNotAuthorizedException,
                                                         InvalidParameterException,
                                                         ClassificationException,
                                                         UnrecognizedGUIDException

Updates classifications to an existing governanceRule represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the governanceRule; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given governanceRule guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteGovernanceRuleClassification

public GovernanceRule deleteGovernanceRuleClassification(String userId,
                                                         String entityGuid,
                                                         String name)
                                                  throws MetadataServerUncontactableException,
                                                         UserNotAuthorizedException,
                                                         InvalidParameterException,
                                                         ClassificationException,
                                                         UnrecognizedGUIDException

Deletes a given classification from an existing governanceRule represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the governanceRule; name - name of the classification
Returns:: deleted GovernanceRule classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getGovernanceRuleRelationships
```
public Set<Line> getGovernanceRuleRelationships(String userId,
                                                String entityGuid,
                                                String relationshipTypeGuid,
                                                int fromRelationshipElement,
                                                Date asOfTime,
                                                String sequencingProperty,
                                                SequencingOrder sequencingOrder,
                                                int pageSize)
                                         throws MetadataServerUncontactableException,
                                                UserNotAuthorizedException,
                                                InvalidParameterException,
                                                FunctionNotSupportedException,
                                                UnrecognizedGUIDException
```
Get the relationships associated with entity governanceRule represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the governanceRule

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getMetadataRepositoryCohortById
```
public MetadataRepositoryCohort getMetadataRepositoryCohortById(String userId,
                                                                String entityGuid)
                                                         throws MetadataServerUncontactableException,
                                                                UserNotAuthorizedException,
                                                                InvalidParameterException,
                                                                UnrecognizedGUIDException
```
Fetch complete definition of an metadataRepositoryCohort given its GUID. The limit and offset paging parameters limit the number elements returned in each of the metadataRepositoryCohorts relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

MetadataRepositoryCohort the MetadataRepositoryCohort entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createMetadataRepositoryCohort

public MetadataRepositoryCohort createMetadataRepositoryCohort(String userId,
                                                               MetadataRepositoryCohort metadataRepositoryCohort)
                                                        throws MetadataServerUncontactableException,
                                                               UserNotAuthorizedException,
                                                               InvalidParameterException,
                                                               ClassificationException,
                                                               StatusNotSupportedException

Create new metadataRepositoryCohort.

Parameters:: userId - user identity; metadataRepositoryCohort - the input entity with values.
Returns:: MetadataRepositoryCohort the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateMetadataRepositoryCohort

public MetadataRepositoryCohort updateMetadataRepositoryCohort(String userId,
                                                               MetadataRepositoryCohort metadataRepositoryCohort)
                                                        throws MetadataServerUncontactableException,
                                                               UserNotAuthorizedException,
                                                               InvalidParameterException,
                                                               UnrecognizedGUIDException

Update metadataRepositoryCohort

Parameters:: userId - user identity; metadataRepositoryCohort - metadataRepositoryCohort to update
Returns:: MetadataRepositoryCohort the updated metadataRepositoryCohort entity
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteMetadataRepositoryCohortByGuid
```
public EntityDetail deleteMetadataRepositoryCohortByGuid(String userId,
                                                         String entityGuid)
                                                  throws MetadataServerUncontactableException,
                                                         UserNotAuthorizedException,
                                                         FunctionNotSupportedException,
                                                         InvalidParameterException,
                                                         UnrecognizedGUIDException
```
Delete an metadataRepositoryCohort identified by its GUID. Delete is a soft delete, this means that the metadataRepositoryCohort has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the metadataRepositoryCohort

Returns:

MetadataRepositoryCohort the deleted MetadataRepositoryCohort entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeMetadataRepositoryCohortByGuid

public void purgeMetadataRepositoryCohortByGuid(String userId,
                                                String entityGuid)
                                         throws MetadataServerUncontactableException,
                                                UserNotAuthorizedException,
                                                InvalidParameterException,
                                                UnrecognizedGUIDException,
                                                EntityNotDeletedException,
                                                GUIDNotPurgedException

Purge an metadataRepositoryCohort identified by its GUID. Delete is a hard delete, this means that the metadataRepositoryCohort is really deleted .

Parameters:: userId - user identity; entityGuid - GUID for the metadataRepositoryCohort
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; EntityNotDeletedException - the entity was not deleted; GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreMetadataRepositoryCohort

public MetadataRepositoryCohort restoreMetadataRepositoryCohort(String userId,
                                                                String entityGuid)
                                                         throws MetadataServerUncontactableException,
                                                                UserNotAuthorizedException,
                                                                InvalidParameterException,
                                                                UnrecognizedGUIDException,
                                                                GUIDNotDeletedException,
                                                                FunctionNotSupportedException

Restore an MetadataRepositoryCohort identified by its GUID. Restore resurrects a soft deleted MetadataRepositoryCohort. When a MetadataRepositoryCohort was incorrectly deleted, the delete can be undone using the restore..

Parameters:: userId - user identity; entityGuid - GUID for the MetadataRepositoryCohort
Returns:: MetadataRepositoryCohort the restored MetadataRepositoryCohort
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; GUIDNotDeletedException - the guid of the MetadataRepositoryCohort is not deleted, so cannot be restored; FunctionNotSupportedException - Function not supported

addMetadataRepositoryCohortClassifications

public MetadataRepositoryCohort addMetadataRepositoryCohortClassifications(String userId,
                                                                           String entityGuid,
                                                                           List<Classification> classifications)
                                                                    throws MetadataServerUncontactableException,
                                                                           UserNotAuthorizedException,
                                                                           InvalidParameterException,
                                                                           ClassificationException,
                                                                           UnrecognizedGUIDException

Add classifications to the supplied metadataRepositoryCohort

Parameters:: userId - user identity; entityGuid - the GUID value for metadataRepositoryCohort; classifications - the classifications to apply.
Returns:: the metadataRepositoryCohort entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateMetadataRepositoryCohortClassification

public MetadataRepositoryCohort updateMetadataRepositoryCohortClassification(String userId,
                                                                             String entityGuid,
                                                                             List<Classification> classificationsToUpdate)
                                                                      throws MetadataServerUncontactableException,
                                                                             UserNotAuthorizedException,
                                                                             InvalidParameterException,
                                                                             ClassificationException,
                                                                             UnrecognizedGUIDException

Updates classifications to an existing metadataRepositoryCohort represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the metadataRepositoryCohort; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given metadataRepositoryCohort guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteMetadataRepositoryCohortClassification

public MetadataRepositoryCohort deleteMetadataRepositoryCohortClassification(String userId,
                                                                             String entityGuid,
                                                                             String name)
                                                                      throws MetadataServerUncontactableException,
                                                                             UserNotAuthorizedException,
                                                                             InvalidParameterException,
                                                                             ClassificationException,
                                                                             UnrecognizedGUIDException

Deletes a given classification from an existing metadataRepositoryCohort represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the metadataRepositoryCohort; name - name of the classification
Returns:: deleted MetadataRepositoryCohort classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getMetadataRepositoryCohortRelationships
```
public Set<Line> getMetadataRepositoryCohortRelationships(String userId,
                                                          String entityGuid,
                                                          String relationshipTypeGuid,
                                                          int fromRelationshipElement,
                                                          Date asOfTime,
                                                          String sequencingProperty,
                                                          SequencingOrder sequencingOrder,
                                                          int pageSize)
                                                   throws MetadataServerUncontactableException,
                                                          UserNotAuthorizedException,
                                                          InvalidParameterException,
                                                          FunctionNotSupportedException,
                                                          UnrecognizedGUIDException
```
Get the relationships associated with entity metadataRepositoryCohort represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the metadataRepositoryCohort

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getNoteLogById
```
public NoteLog getNoteLogById(String userId,
                              String entityGuid)
                       throws MetadataServerUncontactableException,
                              UserNotAuthorizedException,
                              InvalidParameterException,
                              UnrecognizedGUIDException
```
Fetch complete definition of an noteLog given its GUID. The limit and offset paging parameters limit the number elements returned in each of the noteLogs relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

NoteLog the NoteLog entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createNoteLog

public NoteLog createNoteLog(String userId,
                             NoteLog noteLog)
                      throws MetadataServerUncontactableException,
                             UserNotAuthorizedException,
                             InvalidParameterException,
                             ClassificationException,
                             StatusNotSupportedException

Create new noteLog.

Parameters:: userId - user identity; noteLog - the input entity with values.
Returns:: NoteLog the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateNoteLog
```
public NoteLog updateNoteLog(String userId,
                             NoteLog noteLog)
                      throws MetadataServerUncontactableException,
                             UserNotAuthorizedException,
                             InvalidParameterException,
                             UnrecognizedGUIDException
```
Update noteLog

Parameters:

userId - user identity

noteLog - noteLog to update

Returns:

NoteLog the updated noteLog entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteNoteLogByGuid
```
public EntityDetail deleteNoteLogByGuid(String userId,
                                        String entityGuid)
                                 throws MetadataServerUncontactableException,
                                        UserNotAuthorizedException,
                                        FunctionNotSupportedException,
                                        InvalidParameterException,
                                        UnrecognizedGUIDException
```
Delete an noteLog identified by its GUID. Delete is a soft delete, this means that the noteLog has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the noteLog

Returns:

NoteLog the deleted NoteLog entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeNoteLogByGuid
```
public void purgeNoteLogByGuid(String userId,
                               String entityGuid)
                        throws MetadataServerUncontactableException,
                               UserNotAuthorizedException,
                               InvalidParameterException,
                               UnrecognizedGUIDException,
                               EntityNotDeletedException,
                               GUIDNotPurgedException
```
Purge an noteLog identified by its GUID. Delete is a hard delete, this means that the noteLog is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the noteLog

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreNoteLog
```
public NoteLog restoreNoteLog(String userId,
                              String entityGuid)
                       throws MetadataServerUncontactableException,
                              UserNotAuthorizedException,
                              InvalidParameterException,
                              UnrecognizedGUIDException,
                              GUIDNotDeletedException,
                              FunctionNotSupportedException
```
Restore an NoteLog identified by its GUID. Restore resurrects a soft deleted NoteLog. When a NoteLog was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the NoteLog

Returns:

NoteLog the restored NoteLog

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the NoteLog is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addNoteLogClassifications

public NoteLog addNoteLogClassifications(String userId,
                                         String entityGuid,
                                         List<Classification> classifications)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         InvalidParameterException,
                                         ClassificationException,
                                         UnrecognizedGUIDException

Add classifications to the supplied noteLog

Parameters:: userId - user identity; entityGuid - the GUID value for noteLog; classifications - the classifications to apply.
Returns:: the noteLog entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateNoteLogClassification

public NoteLog updateNoteLogClassification(String userId,
                                           String entityGuid,
                                           List<Classification> classificationsToUpdate)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           InvalidParameterException,
                                           ClassificationException,
                                           UnrecognizedGUIDException

Updates classifications to an existing noteLog represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the noteLog; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given noteLog guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteNoteLogClassification

public NoteLog deleteNoteLogClassification(String userId,
                                           String entityGuid,
                                           String name)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           InvalidParameterException,
                                           ClassificationException,
                                           UnrecognizedGUIDException

Deletes a given classification from an existing noteLog represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the noteLog; name - name of the classification
Returns:: deleted NoteLog classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getNoteLogRelationships
```
public Set<Line> getNoteLogRelationships(String userId,
                                         String entityGuid,
                                         String relationshipTypeGuid,
                                         int fromRelationshipElement,
                                         Date asOfTime,
                                         String sequencingProperty,
                                         SequencingOrder sequencingOrder,
                                         int pageSize)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         InvalidParameterException,
                                         FunctionNotSupportedException,
                                         UnrecognizedGUIDException
```
Get the relationships associated with entity noteLog represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the noteLog

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getExternalGlossaryLinkById
```
public ExternalGlossaryLink getExternalGlossaryLinkById(String userId,
                                                        String entityGuid)
                                                 throws MetadataServerUncontactableException,
                                                        UserNotAuthorizedException,
                                                        InvalidParameterException,
                                                        UnrecognizedGUIDException
```
Fetch complete definition of an externalGlossaryLink given its GUID. The limit and offset paging parameters limit the number elements returned in each of the externalGlossaryLinks relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

ExternalGlossaryLink the ExternalGlossaryLink entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createExternalGlossaryLink

public ExternalGlossaryLink createExternalGlossaryLink(String userId,
                                                       ExternalGlossaryLink externalGlossaryLink)
                                                throws MetadataServerUncontactableException,
                                                       UserNotAuthorizedException,
                                                       InvalidParameterException,
                                                       ClassificationException,
                                                       StatusNotSupportedException

Create new externalGlossaryLink.

Parameters:: userId - user identity; externalGlossaryLink - the input entity with values.
Returns:: ExternalGlossaryLink the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateExternalGlossaryLink

public ExternalGlossaryLink updateExternalGlossaryLink(String userId,
                                                       ExternalGlossaryLink externalGlossaryLink)
                                                throws MetadataServerUncontactableException,
                                                       UserNotAuthorizedException,
                                                       InvalidParameterException,
                                                       UnrecognizedGUIDException

Update externalGlossaryLink

Parameters:: userId - user identity; externalGlossaryLink - externalGlossaryLink to update
Returns:: ExternalGlossaryLink the updated externalGlossaryLink entity
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteExternalGlossaryLinkByGuid
```
public EntityDetail deleteExternalGlossaryLinkByGuid(String userId,
                                                     String entityGuid)
                                              throws MetadataServerUncontactableException,
                                                     UserNotAuthorizedException,
                                                     FunctionNotSupportedException,
                                                     InvalidParameterException,
                                                     UnrecognizedGUIDException
```
Delete an externalGlossaryLink identified by its GUID. Delete is a soft delete, this means that the externalGlossaryLink has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the externalGlossaryLink

Returns:

ExternalGlossaryLink the deleted ExternalGlossaryLink entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeExternalGlossaryLinkByGuid
```
public void purgeExternalGlossaryLinkByGuid(String userId,
                                            String entityGuid)
                                     throws MetadataServerUncontactableException,
                                            UserNotAuthorizedException,
                                            InvalidParameterException,
                                            UnrecognizedGUIDException,
                                            EntityNotDeletedException,
                                            GUIDNotPurgedException
```
Purge an externalGlossaryLink identified by its GUID. Delete is a hard delete, this means that the externalGlossaryLink is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the externalGlossaryLink

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreExternalGlossaryLink

public ExternalGlossaryLink restoreExternalGlossaryLink(String userId,
                                                        String entityGuid)
                                                 throws MetadataServerUncontactableException,
                                                        UserNotAuthorizedException,
                                                        InvalidParameterException,
                                                        UnrecognizedGUIDException,
                                                        GUIDNotDeletedException,
                                                        FunctionNotSupportedException

Restore an ExternalGlossaryLink identified by its GUID. Restore resurrects a soft deleted ExternalGlossaryLink. When a ExternalGlossaryLink was incorrectly deleted, the delete can be undone using the restore..

Parameters:: userId - user identity; entityGuid - GUID for the ExternalGlossaryLink
Returns:: ExternalGlossaryLink the restored ExternalGlossaryLink
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; GUIDNotDeletedException - the guid of the ExternalGlossaryLink is not deleted, so cannot be restored; FunctionNotSupportedException - Function not supported

addExternalGlossaryLinkClassifications

public ExternalGlossaryLink addExternalGlossaryLinkClassifications(String userId,
                                                                   String entityGuid,
                                                                   List<Classification> classifications)
                                                            throws MetadataServerUncontactableException,
                                                                   UserNotAuthorizedException,
                                                                   InvalidParameterException,
                                                                   ClassificationException,
                                                                   UnrecognizedGUIDException

Add classifications to the supplied externalGlossaryLink

Parameters:: userId - user identity; entityGuid - the GUID value for externalGlossaryLink; classifications - the classifications to apply.
Returns:: the externalGlossaryLink entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateExternalGlossaryLinkClassification

public ExternalGlossaryLink updateExternalGlossaryLinkClassification(String userId,
                                                                     String entityGuid,
                                                                     List<Classification> classificationsToUpdate)
                                                              throws MetadataServerUncontactableException,
                                                                     UserNotAuthorizedException,
                                                                     InvalidParameterException,
                                                                     ClassificationException,
                                                                     UnrecognizedGUIDException

Updates classifications to an existing externalGlossaryLink represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the externalGlossaryLink; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given externalGlossaryLink guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteExternalGlossaryLinkClassification

public ExternalGlossaryLink deleteExternalGlossaryLinkClassification(String userId,
                                                                     String entityGuid,
                                                                     String name)
                                                              throws MetadataServerUncontactableException,
                                                                     UserNotAuthorizedException,
                                                                     InvalidParameterException,
                                                                     ClassificationException,
                                                                     UnrecognizedGUIDException

Deletes a given classification from an existing externalGlossaryLink represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the externalGlossaryLink; name - name of the classification
Returns:: deleted ExternalGlossaryLink classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getExternalGlossaryLinkRelationships
```
public Set<Line> getExternalGlossaryLinkRelationships(String userId,
                                                      String entityGuid,
                                                      String relationshipTypeGuid,
                                                      int fromRelationshipElement,
                                                      Date asOfTime,
                                                      String sequencingProperty,
                                                      SequencingOrder sequencingOrder,
                                                      int pageSize)
                                               throws MetadataServerUncontactableException,
                                                      UserNotAuthorizedException,
                                                      InvalidParameterException,
                                                      FunctionNotSupportedException,
                                                      UnrecognizedGUIDException
```
Get the relationships associated with entity externalGlossaryLink represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the externalGlossaryLink

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getVirtualConnectionById
```
public VirtualConnection getVirtualConnectionById(String userId,
                                                  String entityGuid)
                                           throws MetadataServerUncontactableException,
                                                  UserNotAuthorizedException,
                                                  InvalidParameterException,
                                                  UnrecognizedGUIDException
```
Fetch complete definition of an virtualConnection given its GUID. The limit and offset paging parameters limit the number elements returned in each of the virtualConnections relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

VirtualConnection the VirtualConnection entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createVirtualConnection

public VirtualConnection createVirtualConnection(String userId,
                                                 VirtualConnection virtualConnection)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 ClassificationException,
                                                 StatusNotSupportedException

Create new virtualConnection.

Parameters:: userId - user identity; virtualConnection - the input entity with values.
Returns:: VirtualConnection the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateVirtualConnection

public VirtualConnection updateVirtualConnection(String userId,
                                                 VirtualConnection virtualConnection)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 UnrecognizedGUIDException

Update virtualConnection

Parameters:: userId - user identity; virtualConnection - virtualConnection to update
Returns:: VirtualConnection the updated virtualConnection entity
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteVirtualConnectionByGuid
```
public EntityDetail deleteVirtualConnectionByGuid(String userId,
                                                  String entityGuid)
                                           throws MetadataServerUncontactableException,
                                                  UserNotAuthorizedException,
                                                  FunctionNotSupportedException,
                                                  InvalidParameterException,
                                                  UnrecognizedGUIDException
```
Delete an virtualConnection identified by its GUID. Delete is a soft delete, this means that the virtualConnection has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the virtualConnection

Returns:

VirtualConnection the deleted VirtualConnection entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeVirtualConnectionByGuid
```
public void purgeVirtualConnectionByGuid(String userId,
                                         String entityGuid)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         InvalidParameterException,
                                         UnrecognizedGUIDException,
                                         EntityNotDeletedException,
                                         GUIDNotPurgedException
```
Purge an virtualConnection identified by its GUID. Delete is a hard delete, this means that the virtualConnection is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the virtualConnection

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreVirtualConnection
```
public VirtualConnection restoreVirtualConnection(String userId,
                                                  String entityGuid)
                                           throws MetadataServerUncontactableException,
                                                  UserNotAuthorizedException,
                                                  InvalidParameterException,
                                                  UnrecognizedGUIDException,
                                                  GUIDNotDeletedException,
                                                  FunctionNotSupportedException
```
Restore an VirtualConnection identified by its GUID. Restore resurrects a soft deleted VirtualConnection. When a VirtualConnection was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the VirtualConnection

Returns:

VirtualConnection the restored VirtualConnection

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the VirtualConnection is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addVirtualConnectionClassifications

public VirtualConnection addVirtualConnectionClassifications(String userId,
                                                             String entityGuid,
                                                             List<Classification> classifications)
                                                      throws MetadataServerUncontactableException,
                                                             UserNotAuthorizedException,
                                                             InvalidParameterException,
                                                             ClassificationException,
                                                             UnrecognizedGUIDException

Add classifications to the supplied virtualConnection

Parameters:: userId - user identity; entityGuid - the GUID value for virtualConnection; classifications - the classifications to apply.
Returns:: the virtualConnection entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateVirtualConnectionClassification

public VirtualConnection updateVirtualConnectionClassification(String userId,
                                                               String entityGuid,
                                                               List<Classification> classificationsToUpdate)
                                                        throws MetadataServerUncontactableException,
                                                               UserNotAuthorizedException,
                                                               InvalidParameterException,
                                                               ClassificationException,
                                                               UnrecognizedGUIDException

Updates classifications to an existing virtualConnection represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the virtualConnection; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given virtualConnection guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteVirtualConnectionClassification

public VirtualConnection deleteVirtualConnectionClassification(String userId,
                                                               String entityGuid,
                                                               String name)
                                                        throws MetadataServerUncontactableException,
                                                               UserNotAuthorizedException,
                                                               InvalidParameterException,
                                                               ClassificationException,
                                                               UnrecognizedGUIDException

Deletes a given classification from an existing virtualConnection represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the virtualConnection; name - name of the classification
Returns:: deleted VirtualConnection classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getVirtualConnectionRelationships
```
public Set<Line> getVirtualConnectionRelationships(String userId,
                                                   String entityGuid,
                                                   String relationshipTypeGuid,
                                                   int fromRelationshipElement,
                                                   Date asOfTime,
                                                   String sequencingProperty,
                                                   SequencingOrder sequencingOrder,
                                                   int pageSize)
                                            throws MetadataServerUncontactableException,
                                                   UserNotAuthorizedException,
                                                   InvalidParameterException,
                                                   FunctionNotSupportedException,
                                                   UnrecognizedGUIDException
```
Get the relationships associated with entity virtualConnection represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the virtualConnection

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getRegulationById
```
public Regulation getRegulationById(String userId,
                                    String entityGuid)
                             throws MetadataServerUncontactableException,
                                    UserNotAuthorizedException,
                                    InvalidParameterException,
                                    UnrecognizedGUIDException
```
Fetch complete definition of an regulation given its GUID. The limit and offset paging parameters limit the number elements returned in each of the regulations relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

Regulation the Regulation entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createRegulation

public Regulation createRegulation(String userId,
                                   Regulation regulation)
                            throws MetadataServerUncontactableException,
                                   UserNotAuthorizedException,
                                   InvalidParameterException,
                                   ClassificationException,
                                   StatusNotSupportedException

Create new regulation.

Parameters:: userId - user identity; regulation - the input entity with values.
Returns:: Regulation the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateRegulation
```
public Regulation updateRegulation(String userId,
                                   Regulation regulation)
                            throws MetadataServerUncontactableException,
                                   UserNotAuthorizedException,
                                   InvalidParameterException,
                                   UnrecognizedGUIDException
```
Update regulation

Parameters:

userId - user identity

regulation - regulation to update

Returns:

Regulation the updated regulation entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteRegulationByGuid
```
public EntityDetail deleteRegulationByGuid(String userId,
                                           String entityGuid)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           FunctionNotSupportedException,
                                           InvalidParameterException,
                                           UnrecognizedGUIDException
```
Delete an regulation identified by its GUID. Delete is a soft delete, this means that the regulation has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the regulation

Returns:

Regulation the deleted Regulation entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeRegulationByGuid
```
public void purgeRegulationByGuid(String userId,
                                  String entityGuid)
                           throws MetadataServerUncontactableException,
                                  UserNotAuthorizedException,
                                  InvalidParameterException,
                                  UnrecognizedGUIDException,
                                  EntityNotDeletedException,
                                  GUIDNotPurgedException
```
Purge an regulation identified by its GUID. Delete is a hard delete, this means that the regulation is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the regulation

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreRegulation
```
public Regulation restoreRegulation(String userId,
                                    String entityGuid)
                             throws MetadataServerUncontactableException,
                                    UserNotAuthorizedException,
                                    InvalidParameterException,
                                    UnrecognizedGUIDException,
                                    GUIDNotDeletedException,
                                    FunctionNotSupportedException
```
Restore an Regulation identified by its GUID. Restore resurrects a soft deleted Regulation. When a Regulation was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the Regulation

Returns:

Regulation the restored Regulation

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the Regulation is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addRegulationClassifications

public Regulation addRegulationClassifications(String userId,
                                               String entityGuid,
                                               List<Classification> classifications)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               InvalidParameterException,
                                               ClassificationException,
                                               UnrecognizedGUIDException

Add classifications to the supplied regulation

Parameters:: userId - user identity; entityGuid - the GUID value for regulation; classifications - the classifications to apply.
Returns:: the regulation entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateRegulationClassification

public Regulation updateRegulationClassification(String userId,
                                                 String entityGuid,
                                                 List<Classification> classificationsToUpdate)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 ClassificationException,
                                                 UnrecognizedGUIDException

Updates classifications to an existing regulation represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the regulation; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given regulation guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteRegulationClassification

public Regulation deleteRegulationClassification(String userId,
                                                 String entityGuid,
                                                 String name)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 ClassificationException,
                                                 UnrecognizedGUIDException

Deletes a given classification from an existing regulation represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the regulation; name - name of the classification
Returns:: deleted Regulation classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getRegulationRelationships
```
public Set<Line> getRegulationRelationships(String userId,
                                            String entityGuid,
                                            String relationshipTypeGuid,
                                            int fromRelationshipElement,
                                            Date asOfTime,
                                            String sequencingProperty,
                                            SequencingOrder sequencingOrder,
                                            int pageSize)
                                     throws MetadataServerUncontactableException,
                                            UserNotAuthorizedException,
                                            InvalidParameterException,
                                            FunctionNotSupportedException,
                                            UnrecognizedGUIDException
```
Get the relationships associated with entity regulation represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the regulation

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getGovernanceProcessById
```
public GovernanceProcess getGovernanceProcessById(String userId,
                                                  String entityGuid)
                                           throws MetadataServerUncontactableException,
                                                  UserNotAuthorizedException,
                                                  InvalidParameterException,
                                                  UnrecognizedGUIDException
```
Fetch complete definition of an governanceProcess given its GUID. The limit and offset paging parameters limit the number elements returned in each of the governanceProcesses relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

GovernanceProcess the GovernanceProcess entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createGovernanceProcess

public GovernanceProcess createGovernanceProcess(String userId,
                                                 GovernanceProcess governanceProcess)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 ClassificationException,
                                                 StatusNotSupportedException

Create new governanceProcess.

Parameters:: userId - user identity; governanceProcess - the input entity with values.
Returns:: GovernanceProcess the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateGovernanceProcess

public GovernanceProcess updateGovernanceProcess(String userId,
                                                 GovernanceProcess governanceProcess)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 UnrecognizedGUIDException

Update governanceProcess

Parameters:: userId - user identity; governanceProcess - governanceProcess to update
Returns:: GovernanceProcess the updated governanceProcess entity
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteGovernanceProcessByGuid
```
public EntityDetail deleteGovernanceProcessByGuid(String userId,
                                                  String entityGuid)
                                           throws MetadataServerUncontactableException,
                                                  UserNotAuthorizedException,
                                                  FunctionNotSupportedException,
                                                  InvalidParameterException,
                                                  UnrecognizedGUIDException
```
Delete an governanceProcess identified by its GUID. Delete is a soft delete, this means that the governanceProcess has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the governanceProcess

Returns:

GovernanceProcess the deleted GovernanceProcess entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeGovernanceProcessByGuid
```
public void purgeGovernanceProcessByGuid(String userId,
                                         String entityGuid)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         InvalidParameterException,
                                         UnrecognizedGUIDException,
                                         EntityNotDeletedException,
                                         GUIDNotPurgedException
```
Purge an governanceProcess identified by its GUID. Delete is a hard delete, this means that the governanceProcess is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the governanceProcess

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreGovernanceProcess
```
public GovernanceProcess restoreGovernanceProcess(String userId,
                                                  String entityGuid)
                                           throws MetadataServerUncontactableException,
                                                  UserNotAuthorizedException,
                                                  InvalidParameterException,
                                                  UnrecognizedGUIDException,
                                                  GUIDNotDeletedException,
                                                  FunctionNotSupportedException
```
Restore an GovernanceProcess identified by its GUID. Restore resurrects a soft deleted GovernanceProcess. When a GovernanceProcess was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the GovernanceProcess

Returns:

GovernanceProcess the restored GovernanceProcess

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the GovernanceProcess is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addGovernanceProcessClassifications

public GovernanceProcess addGovernanceProcessClassifications(String userId,
                                                             String entityGuid,
                                                             List<Classification> classifications)
                                                      throws MetadataServerUncontactableException,
                                                             UserNotAuthorizedException,
                                                             InvalidParameterException,
                                                             ClassificationException,
                                                             UnrecognizedGUIDException

Add classifications to the supplied governanceProcess

Parameters:: userId - user identity; entityGuid - the GUID value for governanceProcess; classifications - the classifications to apply.
Returns:: the governanceProcess entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateGovernanceProcessClassification

public GovernanceProcess updateGovernanceProcessClassification(String userId,
                                                               String entityGuid,
                                                               List<Classification> classificationsToUpdate)
                                                        throws MetadataServerUncontactableException,
                                                               UserNotAuthorizedException,
                                                               InvalidParameterException,
                                                               ClassificationException,
                                                               UnrecognizedGUIDException

Updates classifications to an existing governanceProcess represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the governanceProcess; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given governanceProcess guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteGovernanceProcessClassification

public GovernanceProcess deleteGovernanceProcessClassification(String userId,
                                                               String entityGuid,
                                                               String name)
                                                        throws MetadataServerUncontactableException,
                                                               UserNotAuthorizedException,
                                                               InvalidParameterException,
                                                               ClassificationException,
                                                               UnrecognizedGUIDException

Deletes a given classification from an existing governanceProcess represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the governanceProcess; name - name of the classification
Returns:: deleted GovernanceProcess classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getGovernanceProcessRelationships
```
public Set<Line> getGovernanceProcessRelationships(String userId,
                                                   String entityGuid,
                                                   String relationshipTypeGuid,
                                                   int fromRelationshipElement,
                                                   Date asOfTime,
                                                   String sequencingProperty,
                                                   SequencingOrder sequencingOrder,
                                                   int pageSize)
                                            throws MetadataServerUncontactableException,
                                                   UserNotAuthorizedException,
                                                   InvalidParameterException,
                                                   FunctionNotSupportedException,
                                                   UnrecognizedGUIDException
```
Get the relationships associated with entity governanceProcess represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the governanceProcess

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getSchemaAttributeById
```
public SchemaAttribute getSchemaAttributeById(String userId,
                                              String entityGuid)
                                       throws MetadataServerUncontactableException,
                                              UserNotAuthorizedException,
                                              InvalidParameterException,
                                              UnrecognizedGUIDException
```
Fetch complete definition of an schemaAttribute given its GUID. The limit and offset paging parameters limit the number elements returned in each of the schemaAttributes relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

SchemaAttribute the SchemaAttribute entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createSchemaAttribute

public SchemaAttribute createSchemaAttribute(String userId,
                                             SchemaAttribute schemaAttribute)
                                      throws MetadataServerUncontactableException,
                                             UserNotAuthorizedException,
                                             InvalidParameterException,
                                             ClassificationException,
                                             StatusNotSupportedException

Create new schemaAttribute.

Parameters:: userId - user identity; schemaAttribute - the input entity with values.
Returns:: SchemaAttribute the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateSchemaAttribute

public SchemaAttribute updateSchemaAttribute(String userId,
                                             SchemaAttribute schemaAttribute)
                                      throws MetadataServerUncontactableException,
                                             UserNotAuthorizedException,
                                             InvalidParameterException,
                                             UnrecognizedGUIDException

Update schemaAttribute

Parameters:: userId - user identity; schemaAttribute - schemaAttribute to update
Returns:: SchemaAttribute the updated schemaAttribute entity
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteSchemaAttributeByGuid
```
public EntityDetail deleteSchemaAttributeByGuid(String userId,
                                                String entityGuid)
                                         throws MetadataServerUncontactableException,
                                                UserNotAuthorizedException,
                                                FunctionNotSupportedException,
                                                InvalidParameterException,
                                                UnrecognizedGUIDException
```
Delete an schemaAttribute identified by its GUID. Delete is a soft delete, this means that the schemaAttribute has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the schemaAttribute

Returns:

SchemaAttribute the deleted SchemaAttribute entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeSchemaAttributeByGuid
```
public void purgeSchemaAttributeByGuid(String userId,
                                       String entityGuid)
                                throws MetadataServerUncontactableException,
                                       UserNotAuthorizedException,
                                       InvalidParameterException,
                                       UnrecognizedGUIDException,
                                       EntityNotDeletedException,
                                       GUIDNotPurgedException
```
Purge an schemaAttribute identified by its GUID. Delete is a hard delete, this means that the schemaAttribute is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the schemaAttribute

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreSchemaAttribute
```
public SchemaAttribute restoreSchemaAttribute(String userId,
                                              String entityGuid)
                                       throws MetadataServerUncontactableException,
                                              UserNotAuthorizedException,
                                              InvalidParameterException,
                                              UnrecognizedGUIDException,
                                              GUIDNotDeletedException,
                                              FunctionNotSupportedException
```
Restore an SchemaAttribute identified by its GUID. Restore resurrects a soft deleted SchemaAttribute. When a SchemaAttribute was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the SchemaAttribute

Returns:

SchemaAttribute the restored SchemaAttribute

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the SchemaAttribute is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addSchemaAttributeClassifications

public SchemaAttribute addSchemaAttributeClassifications(String userId,
                                                         String entityGuid,
                                                         List<Classification> classifications)
                                                  throws MetadataServerUncontactableException,
                                                         UserNotAuthorizedException,
                                                         InvalidParameterException,
                                                         ClassificationException,
                                                         UnrecognizedGUIDException

Add classifications to the supplied schemaAttribute

Parameters:: userId - user identity; entityGuid - the GUID value for schemaAttribute; classifications - the classifications to apply.
Returns:: the schemaAttribute entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateSchemaAttributeClassification

public SchemaAttribute updateSchemaAttributeClassification(String userId,
                                                           String entityGuid,
                                                           List<Classification> classificationsToUpdate)
                                                    throws MetadataServerUncontactableException,
                                                           UserNotAuthorizedException,
                                                           InvalidParameterException,
                                                           ClassificationException,
                                                           UnrecognizedGUIDException

Updates classifications to an existing schemaAttribute represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the schemaAttribute; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given schemaAttribute guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteSchemaAttributeClassification

public SchemaAttribute deleteSchemaAttributeClassification(String userId,
                                                           String entityGuid,
                                                           String name)
                                                    throws MetadataServerUncontactableException,
                                                           UserNotAuthorizedException,
                                                           InvalidParameterException,
                                                           ClassificationException,
                                                           UnrecognizedGUIDException

Deletes a given classification from an existing schemaAttribute represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the schemaAttribute; name - name of the classification
Returns:: deleted SchemaAttribute classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getSchemaAttributeRelationships
```
public Set<Line> getSchemaAttributeRelationships(String userId,
                                                 String entityGuid,
                                                 String relationshipTypeGuid,
                                                 int fromRelationshipElement,
                                                 Date asOfTime,
                                                 String sequencingProperty,
                                                 SequencingOrder sequencingOrder,
                                                 int pageSize)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 FunctionNotSupportedException,
                                                 UnrecognizedGUIDException
```
Get the relationships associated with entity schemaAttribute represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the schemaAttribute

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getGraphEdgeById
```
public GraphEdge getGraphEdgeById(String userId,
                                  String entityGuid)
                           throws MetadataServerUncontactableException,
                                  UserNotAuthorizedException,
                                  InvalidParameterException,
                                  UnrecognizedGUIDException
```
Fetch complete definition of an graphEdge given its GUID. The limit and offset paging parameters limit the number elements returned in each of the graphEdges relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

GraphEdge the GraphEdge entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createGraphEdge

public GraphEdge createGraphEdge(String userId,
                                 GraphEdge graphEdge)
                          throws MetadataServerUncontactableException,
                                 UserNotAuthorizedException,
                                 InvalidParameterException,
                                 ClassificationException,
                                 StatusNotSupportedException

Create new graphEdge.

Parameters:: userId - user identity; graphEdge - the input entity with values.
Returns:: GraphEdge the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateGraphEdge
```
public GraphEdge updateGraphEdge(String userId,
                                 GraphEdge graphEdge)
                          throws MetadataServerUncontactableException,
                                 UserNotAuthorizedException,
                                 InvalidParameterException,
                                 UnrecognizedGUIDException
```
Update graphEdge

Parameters:

userId - user identity

graphEdge - graphEdge to update

Returns:

GraphEdge the updated graphEdge entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteGraphEdgeByGuid
```
public EntityDetail deleteGraphEdgeByGuid(String userId,
                                          String entityGuid)
                                   throws MetadataServerUncontactableException,
                                          UserNotAuthorizedException,
                                          FunctionNotSupportedException,
                                          InvalidParameterException,
                                          UnrecognizedGUIDException
```
Delete an graphEdge identified by its GUID. Delete is a soft delete, this means that the graphEdge has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the graphEdge

Returns:

GraphEdge the deleted GraphEdge entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeGraphEdgeByGuid
```
public void purgeGraphEdgeByGuid(String userId,
                                 String entityGuid)
                          throws MetadataServerUncontactableException,
                                 UserNotAuthorizedException,
                                 InvalidParameterException,
                                 UnrecognizedGUIDException,
                                 EntityNotDeletedException,
                                 GUIDNotPurgedException
```
Purge an graphEdge identified by its GUID. Delete is a hard delete, this means that the graphEdge is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the graphEdge

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreGraphEdge
```
public GraphEdge restoreGraphEdge(String userId,
                                  String entityGuid)
                           throws MetadataServerUncontactableException,
                                  UserNotAuthorizedException,
                                  InvalidParameterException,
                                  UnrecognizedGUIDException,
                                  GUIDNotDeletedException,
                                  FunctionNotSupportedException
```
Restore an GraphEdge identified by its GUID. Restore resurrects a soft deleted GraphEdge. When a GraphEdge was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the GraphEdge

Returns:

GraphEdge the restored GraphEdge

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the GraphEdge is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addGraphEdgeClassifications

public GraphEdge addGraphEdgeClassifications(String userId,
                                             String entityGuid,
                                             List<Classification> classifications)
                                      throws MetadataServerUncontactableException,
                                             UserNotAuthorizedException,
                                             InvalidParameterException,
                                             ClassificationException,
                                             UnrecognizedGUIDException

Add classifications to the supplied graphEdge

Parameters:: userId - user identity; entityGuid - the GUID value for graphEdge; classifications - the classifications to apply.
Returns:: the graphEdge entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateGraphEdgeClassification

public GraphEdge updateGraphEdgeClassification(String userId,
                                               String entityGuid,
                                               List<Classification> classificationsToUpdate)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               InvalidParameterException,
                                               ClassificationException,
                                               UnrecognizedGUIDException

Updates classifications to an existing graphEdge represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the graphEdge; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given graphEdge guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteGraphEdgeClassification

public GraphEdge deleteGraphEdgeClassification(String userId,
                                               String entityGuid,
                                               String name)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               InvalidParameterException,
                                               ClassificationException,
                                               UnrecognizedGUIDException

Deletes a given classification from an existing graphEdge represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the graphEdge; name - name of the classification
Returns:: deleted GraphEdge classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getGraphEdgeRelationships
```
public Set<Line> getGraphEdgeRelationships(String userId,
                                           String entityGuid,
                                           String relationshipTypeGuid,
                                           int fromRelationshipElement,
                                           Date asOfTime,
                                           String sequencingProperty,
                                           SequencingOrder sequencingOrder,
                                           int pageSize)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           InvalidParameterException,
                                           FunctionNotSupportedException,
                                           UnrecognizedGUIDException
```
Get the relationships associated with entity graphEdge represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the graphEdge

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getCommunityById
```
public Community getCommunityById(String userId,
                                  String entityGuid)
                           throws MetadataServerUncontactableException,
                                  UserNotAuthorizedException,
                                  InvalidParameterException,
                                  UnrecognizedGUIDException
```
Fetch complete definition of an community given its GUID. The limit and offset paging parameters limit the number elements returned in each of the communities relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

Community the Community entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createCommunity

public Community createCommunity(String userId,
                                 Community community)
                          throws MetadataServerUncontactableException,
                                 UserNotAuthorizedException,
                                 InvalidParameterException,
                                 ClassificationException,
                                 StatusNotSupportedException

Create new community.

Parameters:: userId - user identity; community - the input entity with values.
Returns:: Community the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateCommunity
```
public Community updateCommunity(String userId,
                                 Community community)
                          throws MetadataServerUncontactableException,
                                 UserNotAuthorizedException,
                                 InvalidParameterException,
                                 UnrecognizedGUIDException
```
Update community

Parameters:

userId - user identity

community - community to update

Returns:

Community the updated community entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteCommunityByGuid
```
public EntityDetail deleteCommunityByGuid(String userId,
                                          String entityGuid)
                                   throws MetadataServerUncontactableException,
                                          UserNotAuthorizedException,
                                          FunctionNotSupportedException,
                                          InvalidParameterException,
                                          UnrecognizedGUIDException
```
Delete an community identified by its GUID. Delete is a soft delete, this means that the community has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the community

Returns:

Community the deleted Community entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeCommunityByGuid
```
public void purgeCommunityByGuid(String userId,
                                 String entityGuid)
                          throws MetadataServerUncontactableException,
                                 UserNotAuthorizedException,
                                 InvalidParameterException,
                                 UnrecognizedGUIDException,
                                 EntityNotDeletedException,
                                 GUIDNotPurgedException
```
Purge an community identified by its GUID. Delete is a hard delete, this means that the community is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the community

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreCommunity
```
public Community restoreCommunity(String userId,
                                  String entityGuid)
                           throws MetadataServerUncontactableException,
                                  UserNotAuthorizedException,
                                  InvalidParameterException,
                                  UnrecognizedGUIDException,
                                  GUIDNotDeletedException,
                                  FunctionNotSupportedException
```
Restore an Community identified by its GUID. Restore resurrects a soft deleted Community. When a Community was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the Community

Returns:

Community the restored Community

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the Community is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addCommunityClassifications

public Community addCommunityClassifications(String userId,
                                             String entityGuid,
                                             List<Classification> classifications)
                                      throws MetadataServerUncontactableException,
                                             UserNotAuthorizedException,
                                             InvalidParameterException,
                                             ClassificationException,
                                             UnrecognizedGUIDException

Add classifications to the supplied community

Parameters:: userId - user identity; entityGuid - the GUID value for community; classifications - the classifications to apply.
Returns:: the community entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateCommunityClassification

public Community updateCommunityClassification(String userId,
                                               String entityGuid,
                                               List<Classification> classificationsToUpdate)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               InvalidParameterException,
                                               ClassificationException,
                                               UnrecognizedGUIDException

Updates classifications to an existing community represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the community; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given community guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteCommunityClassification

public Community deleteCommunityClassification(String userId,
                                               String entityGuid,
                                               String name)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               InvalidParameterException,
                                               ClassificationException,
                                               UnrecognizedGUIDException

Deletes a given classification from an existing community represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the community; name - name of the classification
Returns:: deleted Community classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getCommunityRelationships
```
public Set<Line> getCommunityRelationships(String userId,
                                           String entityGuid,
                                           String relationshipTypeGuid,
                                           int fromRelationshipElement,
                                           Date asOfTime,
                                           String sequencingProperty,
                                           SequencingOrder sequencingOrder,
                                           int pageSize)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           InvalidParameterException,
                                           FunctionNotSupportedException,
                                           UnrecognizedGUIDException
```
Get the relationships associated with entity community represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the community

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getLocationById
```
public Location getLocationById(String userId,
                                String entityGuid)
                         throws MetadataServerUncontactableException,
                                UserNotAuthorizedException,
                                InvalidParameterException,
                                UnrecognizedGUIDException
```
Fetch complete definition of an location given its GUID. The limit and offset paging parameters limit the number elements returned in each of the locations relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

Location the Location entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createLocation

public Location createLocation(String userId,
                               Location location)
                        throws MetadataServerUncontactableException,
                               UserNotAuthorizedException,
                               InvalidParameterException,
                               ClassificationException,
                               StatusNotSupportedException

Create new location.

Parameters:: userId - user identity; location - the input entity with values.
Returns:: Location the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateLocation
```
public Location updateLocation(String userId,
                               Location location)
                        throws MetadataServerUncontactableException,
                               UserNotAuthorizedException,
                               InvalidParameterException,
                               UnrecognizedGUIDException
```
Update location

Parameters:

userId - user identity

location - location to update

Returns:

Location the updated location entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteLocationByGuid
```
public EntityDetail deleteLocationByGuid(String userId,
                                         String entityGuid)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         FunctionNotSupportedException,
                                         InvalidParameterException,
                                         UnrecognizedGUIDException
```
Delete an location identified by its GUID. Delete is a soft delete, this means that the location has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the location

Returns:

Location the deleted Location entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeLocationByGuid
```
public void purgeLocationByGuid(String userId,
                                String entityGuid)
                         throws MetadataServerUncontactableException,
                                UserNotAuthorizedException,
                                InvalidParameterException,
                                UnrecognizedGUIDException,
                                EntityNotDeletedException,
                                GUIDNotPurgedException
```
Purge an location identified by its GUID. Delete is a hard delete, this means that the location is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the location

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreLocation
```
public Location restoreLocation(String userId,
                                String entityGuid)
                         throws MetadataServerUncontactableException,
                                UserNotAuthorizedException,
                                InvalidParameterException,
                                UnrecognizedGUIDException,
                                GUIDNotDeletedException,
                                FunctionNotSupportedException
```
Restore an Location identified by its GUID. Restore resurrects a soft deleted Location. When a Location was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the Location

Returns:

Location the restored Location

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the Location is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addLocationClassifications

public Location addLocationClassifications(String userId,
                                           String entityGuid,
                                           List<Classification> classifications)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           InvalidParameterException,
                                           ClassificationException,
                                           UnrecognizedGUIDException

Add classifications to the supplied location

Parameters:: userId - user identity; entityGuid - the GUID value for location; classifications - the classifications to apply.
Returns:: the location entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateLocationClassification

public Location updateLocationClassification(String userId,
                                             String entityGuid,
                                             List<Classification> classificationsToUpdate)
                                      throws MetadataServerUncontactableException,
                                             UserNotAuthorizedException,
                                             InvalidParameterException,
                                             ClassificationException,
                                             UnrecognizedGUIDException

Updates classifications to an existing location represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the location; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given location guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteLocationClassification

public Location deleteLocationClassification(String userId,
                                             String entityGuid,
                                             String name)
                                      throws MetadataServerUncontactableException,
                                             UserNotAuthorizedException,
                                             InvalidParameterException,
                                             ClassificationException,
                                             UnrecognizedGUIDException

Deletes a given classification from an existing location represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the location; name - name of the classification
Returns:: deleted Location classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getLocationRelationships
```
public Set<Line> getLocationRelationships(String userId,
                                          String entityGuid,
                                          String relationshipTypeGuid,
                                          int fromRelationshipElement,
                                          Date asOfTime,
                                          String sequencingProperty,
                                          SequencingOrder sequencingOrder,
                                          int pageSize)
                                   throws MetadataServerUncontactableException,
                                          UserNotAuthorizedException,
                                          InvalidParameterException,
                                          FunctionNotSupportedException,
                                          UnrecognizedGUIDException
```
Get the relationships associated with entity location represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the location

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getBusinessCapabilityById
```
public BusinessCapability getBusinessCapabilityById(String userId,
                                                    String entityGuid)
                                             throws MetadataServerUncontactableException,
                                                    UserNotAuthorizedException,
                                                    InvalidParameterException,
                                                    UnrecognizedGUIDException
```
Fetch complete definition of an businessCapability given its GUID. The limit and offset paging parameters limit the number elements returned in each of the businessCapabilities relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

BusinessCapability the BusinessCapability entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createBusinessCapability

public BusinessCapability createBusinessCapability(String userId,
                                                   BusinessCapability businessCapability)
                                            throws MetadataServerUncontactableException,
                                                   UserNotAuthorizedException,
                                                   InvalidParameterException,
                                                   ClassificationException,
                                                   StatusNotSupportedException

Create new businessCapability.

Parameters:: userId - user identity; businessCapability - the input entity with values.
Returns:: BusinessCapability the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateBusinessCapability

public BusinessCapability updateBusinessCapability(String userId,
                                                   BusinessCapability businessCapability)
                                            throws MetadataServerUncontactableException,
                                                   UserNotAuthorizedException,
                                                   InvalidParameterException,
                                                   UnrecognizedGUIDException

Update businessCapability

Parameters:: userId - user identity; businessCapability - businessCapability to update
Returns:: BusinessCapability the updated businessCapability entity
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteBusinessCapabilityByGuid
```
public EntityDetail deleteBusinessCapabilityByGuid(String userId,
                                                   String entityGuid)
                                            throws MetadataServerUncontactableException,
                                                   UserNotAuthorizedException,
                                                   FunctionNotSupportedException,
                                                   InvalidParameterException,
                                                   UnrecognizedGUIDException
```
Delete an businessCapability identified by its GUID. Delete is a soft delete, this means that the businessCapability has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the businessCapability

Returns:

BusinessCapability the deleted BusinessCapability entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeBusinessCapabilityByGuid
```
public void purgeBusinessCapabilityByGuid(String userId,
                                          String entityGuid)
                                   throws MetadataServerUncontactableException,
                                          UserNotAuthorizedException,
                                          InvalidParameterException,
                                          UnrecognizedGUIDException,
                                          EntityNotDeletedException,
                                          GUIDNotPurgedException
```
Purge an businessCapability identified by its GUID. Delete is a hard delete, this means that the businessCapability is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the businessCapability

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreBusinessCapability

public BusinessCapability restoreBusinessCapability(String userId,
                                                    String entityGuid)
                                             throws MetadataServerUncontactableException,
                                                    UserNotAuthorizedException,
                                                    InvalidParameterException,
                                                    UnrecognizedGUIDException,
                                                    GUIDNotDeletedException,
                                                    FunctionNotSupportedException

Restore an BusinessCapability identified by its GUID. Restore resurrects a soft deleted BusinessCapability. When a BusinessCapability was incorrectly deleted, the delete can be undone using the restore..

Parameters:: userId - user identity; entityGuid - GUID for the BusinessCapability
Returns:: BusinessCapability the restored BusinessCapability
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; GUIDNotDeletedException - the guid of the BusinessCapability is not deleted, so cannot be restored; FunctionNotSupportedException - Function not supported

addBusinessCapabilityClassifications

public BusinessCapability addBusinessCapabilityClassifications(String userId,
                                                               String entityGuid,
                                                               List<Classification> classifications)
                                                        throws MetadataServerUncontactableException,
                                                               UserNotAuthorizedException,
                                                               InvalidParameterException,
                                                               ClassificationException,
                                                               UnrecognizedGUIDException

Add classifications to the supplied businessCapability

Parameters:: userId - user identity; entityGuid - the GUID value for businessCapability; classifications - the classifications to apply.
Returns:: the businessCapability entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateBusinessCapabilityClassification

public BusinessCapability updateBusinessCapabilityClassification(String userId,
                                                                 String entityGuid,
                                                                 List<Classification> classificationsToUpdate)
                                                          throws MetadataServerUncontactableException,
                                                                 UserNotAuthorizedException,
                                                                 InvalidParameterException,
                                                                 ClassificationException,
                                                                 UnrecognizedGUIDException

Updates classifications to an existing businessCapability represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the businessCapability; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given businessCapability guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteBusinessCapabilityClassification

public BusinessCapability deleteBusinessCapabilityClassification(String userId,
                                                                 String entityGuid,
                                                                 String name)
                                                          throws MetadataServerUncontactableException,
                                                                 UserNotAuthorizedException,
                                                                 InvalidParameterException,
                                                                 ClassificationException,
                                                                 UnrecognizedGUIDException

Deletes a given classification from an existing businessCapability represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the businessCapability; name - name of the classification
Returns:: deleted BusinessCapability classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getBusinessCapabilityRelationships
```
public Set<Line> getBusinessCapabilityRelationships(String userId,
                                                    String entityGuid,
                                                    String relationshipTypeGuid,
                                                    int fromRelationshipElement,
                                                    Date asOfTime,
                                                    String sequencingProperty,
                                                    SequencingOrder sequencingOrder,
                                                    int pageSize)
                                             throws MetadataServerUncontactableException,
                                                    UserNotAuthorizedException,
                                                    InvalidParameterException,
                                                    FunctionNotSupportedException,
                                                    UnrecognizedGUIDException
```
Get the relationships associated with entity businessCapability represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the businessCapability

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

getSchemaLinkElementById
```
public SchemaLinkElement getSchemaLinkElementById(String userId,
                                                  String entityGuid)
                                           throws MetadataServerUncontactableException,
                                                  UserNotAuthorizedException,
                                                  InvalidParameterException,
                                                  UnrecognizedGUIDException
```
Fetch complete definition of an schemaLinkElement given its GUID. The limit and offset paging parameters limit the number elements returned in each of the schemaLinkElements relationships.

Parameters:

userId - user identity

entityGuid - GUID for the entity

Returns:

SchemaLinkElement the SchemaLinkElement entity with the requested GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object. the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

createSchemaLinkElement

public SchemaLinkElement createSchemaLinkElement(String userId,
                                                 SchemaLinkElement schemaLinkElement)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 ClassificationException,
                                                 StatusNotSupportedException

Create new schemaLinkElement.

Parameters:: userId - user identity; schemaLinkElement - the input entity with values.
Returns:: SchemaLinkElement the created entity.
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; ClassificationException - a classification does not match constraints.; StatusNotSupportedException - status is not supported

updateSchemaLinkElement

public SchemaLinkElement updateSchemaLinkElement(String userId,
                                                 SchemaLinkElement schemaLinkElement)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 UnrecognizedGUIDException

Update schemaLinkElement

Parameters:: userId - user identity; schemaLinkElement - schemaLinkElement to update
Returns:: SchemaLinkElement the updated schemaLinkElement entity
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

deleteSchemaLinkElementByGuid
```
public EntityDetail deleteSchemaLinkElementByGuid(String userId,
                                                  String entityGuid)
                                           throws MetadataServerUncontactableException,
                                                  UserNotAuthorizedException,
                                                  FunctionNotSupportedException,
                                                  InvalidParameterException,
                                                  UnrecognizedGUIDException
```
Delete an schemaLinkElement identified by its GUID. Delete is a soft delete, this means that the schemaLinkElement has its status changed to deleted. Soft deletion support os optional, so this call may fail. Soft deletes can be undone using the restore call. If it is required that an entity is really deleted (a hard delete) then the purge call should be used.

Parameters:

userId - user identity

entityGuid - GUID for the schemaLinkElement

Returns:

SchemaLinkElement the deleted SchemaLinkElement entity

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

FunctionNotSupportedException - a function is not supported.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

purgeSchemaLinkElementByGuid
```
public void purgeSchemaLinkElementByGuid(String userId,
                                         String entityGuid)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         InvalidParameterException,
                                         UnrecognizedGUIDException,
                                         EntityNotDeletedException,
                                         GUIDNotPurgedException
```
Purge an schemaLinkElement identified by its GUID. Delete is a hard delete, this means that the schemaLinkElement is really deleted .

Parameters:

userId - user identity

entityGuid - GUID for the schemaLinkElement

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

EntityNotDeletedException - the entity was not deleted

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreSchemaLinkElement
```
public SchemaLinkElement restoreSchemaLinkElement(String userId,
                                                  String entityGuid)
                                           throws MetadataServerUncontactableException,
                                                  UserNotAuthorizedException,
                                                  InvalidParameterException,
                                                  UnrecognizedGUIDException,
                                                  GUIDNotDeletedException,
                                                  FunctionNotSupportedException
```
Restore an SchemaLinkElement identified by its GUID. Restore resurrects a soft deleted SchemaLinkElement. When a SchemaLinkElement was incorrectly deleted, the delete can be undone using the restore..

Parameters:

userId - user identity

entityGuid - GUID for the SchemaLinkElement

Returns:

SchemaLinkElement the restored SchemaLinkElement

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the SchemaLinkElement is not deleted, so cannot be restored

FunctionNotSupportedException - Function not supported

addSchemaLinkElementClassifications

public SchemaLinkElement addSchemaLinkElementClassifications(String userId,
                                                             String entityGuid,
                                                             List<Classification> classifications)
                                                      throws MetadataServerUncontactableException,
                                                             UserNotAuthorizedException,
                                                             InvalidParameterException,
                                                             ClassificationException,
                                                             UnrecognizedGUIDException

Add classifications to the supplied schemaLinkElement

Parameters:: userId - user identity; entityGuid - the GUID value for schemaLinkElement; classifications - the classifications to apply.
Returns:: the schemaLinkElement entity that has been classified
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

updateSchemaLinkElementClassification

public SchemaLinkElement updateSchemaLinkElementClassification(String userId,
                                                               String entityGuid,
                                                               List<Classification> classificationsToUpdate)
                                                        throws MetadataServerUncontactableException,
                                                               UserNotAuthorizedException,
                                                               InvalidParameterException,
                                                               ClassificationException,
                                                               UnrecognizedGUIDException

Updates classifications to an existing schemaLinkElement represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the schemaLinkElement; classificationsToUpdate - List of classifications to update entity with
Returns:: classification for the given schemaLinkElement guid
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

deleteSchemaLinkElementClassification

public SchemaLinkElement deleteSchemaLinkElementClassification(String userId,
                                                               String entityGuid,
                                                               String name)
                                                        throws MetadataServerUncontactableException,
                                                               UserNotAuthorizedException,
                                                               InvalidParameterException,
                                                               ClassificationException,
                                                               UnrecognizedGUIDException

Deletes a given classification from an existing schemaLinkElement represented by a guid.

Parameters:: userId - user identity; entityGuid - globally unique identifier for the schemaLinkElement; name - name of the classification
Returns:: deleted SchemaLinkElement classification
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; ClassificationException - a classification does not match constraints.

getSchemaLinkElementRelationships
```
public Set<Line> getSchemaLinkElementRelationships(String userId,
                                                   String entityGuid,
                                                   String relationshipTypeGuid,
                                                   int fromRelationshipElement,
                                                   Date asOfTime,
                                                   String sequencingProperty,
                                                   SequencingOrder sequencingOrder,
                                                   int pageSize)
                                            throws MetadataServerUncontactableException,
                                                   UserNotAuthorizedException,
                                                   InvalidParameterException,
                                                   FunctionNotSupportedException,
                                                   UnrecognizedGUIDException
```
Get the relationships associated with entity schemaLinkElement represented by a guid.

Parameters:

userId - user identity

entityGuid - globally unique identifier for the schemaLinkElement

relationshipTypeGuid - the guid of the relationship type to restrict the relationships returned to this type. null means return all relationship types.

fromRelationshipElement - the starting element number of the relationships to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.

asOfTime - Date return relationships as they were at some time in the past. null indicates to return relationships as they are now.

sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).

sequencingOrder - Enum defining how the results should be ordered.

pageSize - the maximum number of result classifications that can be returned on this request. Zero means unrestricted return results size.

Returns:

List<Line>

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

createUsedInContextRelationship

public UsedInContext createUsedInContextRelationship(String userId,
                                                     UsedInContext relationship)
                                              throws MetadataServerUncontactableException,
                                                     UserNotAuthorizedException,
                                                     InvalidParameterException,
                                                     UnrecognizedGUIDException,
                                                     StatusNotSupportedException

Create UsedInContext relationship

Parameters:: userId - user identity; relationship - UsedInContext relationship to create
Returns:: created UsedInContext relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getUsedInContextRelationshipByGuid

public UsedInContext getUsedInContextRelationshipByGuid(String userId,
                                                        String relationshipGuid)
                                                 throws MetadataServerUncontactableException,
                                                        UserNotAuthorizedException,
                                                        InvalidParameterException,
                                                        UnrecognizedGUIDException

Get UsedInContext relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: UsedInContext relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateUsedInContextRelationship

public UsedInContext updateUsedInContextRelationship(String userId,
                                                     UsedInContext usedInContext)
                                              throws UserNotAuthorizedException,
                                                     MetadataServerUncontactableException,
                                                     InvalidParameterException,
                                                     StatusNotSupportedException,
                                                     UnrecognizedGUIDException

Update UsedInContext relationship

Parameters:: userId - user identity; usedInContext - relationship
Returns:: UsedInContext relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createAttachedCommentRelationship

public AttachedComment createAttachedCommentRelationship(String userId,
                                                         AttachedComment relationship)
                                                  throws MetadataServerUncontactableException,
                                                         UserNotAuthorizedException,
                                                         InvalidParameterException,
                                                         UnrecognizedGUIDException,
                                                         StatusNotSupportedException

Create AttachedComment relationship

Parameters:: userId - user identity; relationship - AttachedComment relationship to create
Returns:: created AttachedComment relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getAttachedCommentRelationshipByGuid

public AttachedComment getAttachedCommentRelationshipByGuid(String userId,
                                                            String relationshipGuid)
                                                     throws MetadataServerUncontactableException,
                                                            UserNotAuthorizedException,
                                                            InvalidParameterException,
                                                            UnrecognizedGUIDException

Get AttachedComment relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: AttachedComment relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateAttachedCommentRelationship

public AttachedComment updateAttachedCommentRelationship(String userId,
                                                         AttachedComment attachedComment)
                                                  throws UserNotAuthorizedException,
                                                         MetadataServerUncontactableException,
                                                         InvalidParameterException,
                                                         StatusNotSupportedException,
                                                         UnrecognizedGUIDException

Update AttachedComment relationship

Parameters:: userId - user identity; attachedComment - relationship
Returns:: AttachedComment relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createContactThroughRelationship

public ContactThrough createContactThroughRelationship(String userId,
                                                       ContactThrough relationship)
                                                throws MetadataServerUncontactableException,
                                                       UserNotAuthorizedException,
                                                       InvalidParameterException,
                                                       UnrecognizedGUIDException,
                                                       StatusNotSupportedException

Create ContactThrough relationship

Parameters:: userId - user identity; relationship - ContactThrough relationship to create
Returns:: created ContactThrough relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getContactThroughRelationshipByGuid

public ContactThrough getContactThroughRelationshipByGuid(String userId,
                                                          String relationshipGuid)
                                                   throws MetadataServerUncontactableException,
                                                          UserNotAuthorizedException,
                                                          InvalidParameterException,
                                                          UnrecognizedGUIDException

Get ContactThrough relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: ContactThrough relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateContactThroughRelationship

public ContactThrough updateContactThroughRelationship(String userId,
                                                       ContactThrough contactThrough)
                                                throws UserNotAuthorizedException,
                                                       MetadataServerUncontactableException,
                                                       InvalidParameterException,
                                                       StatusNotSupportedException,
                                                       UnrecognizedGUIDException

Update ContactThrough relationship

Parameters:: userId - user identity; contactThrough - relationship
Returns:: ContactThrough relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createLicenseRelationship

public License createLicenseRelationship(String userId,
                                         License relationship)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         InvalidParameterException,
                                         UnrecognizedGUIDException,
                                         StatusNotSupportedException

Create License relationship

Parameters:: userId - user identity; relationship - License relationship to create
Returns:: created License relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getLicenseRelationshipByGuid

public License getLicenseRelationshipByGuid(String userId,
                                            String relationshipGuid)
                                     throws MetadataServerUncontactableException,
                                            UserNotAuthorizedException,
                                            InvalidParameterException,
                                            UnrecognizedGUIDException

Get License relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: License relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateLicenseRelationship

public License updateLicenseRelationship(String userId,
                                         License license)
                                  throws UserNotAuthorizedException,
                                         MetadataServerUncontactableException,
                                         InvalidParameterException,
                                         StatusNotSupportedException,
                                         UnrecognizedGUIDException

Update License relationship

Parameters:: userId - user identity; license - relationship
Returns:: License relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createZoneGovernanceRelationship

public ZoneGovernance createZoneGovernanceRelationship(String userId,
                                                       ZoneGovernance relationship)
                                                throws MetadataServerUncontactableException,
                                                       UserNotAuthorizedException,
                                                       InvalidParameterException,
                                                       UnrecognizedGUIDException,
                                                       StatusNotSupportedException

Create ZoneGovernance relationship

Parameters:: userId - user identity; relationship - ZoneGovernance relationship to create
Returns:: created ZoneGovernance relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getZoneGovernanceRelationshipByGuid

public ZoneGovernance getZoneGovernanceRelationshipByGuid(String userId,
                                                          String relationshipGuid)
                                                   throws MetadataServerUncontactableException,
                                                          UserNotAuthorizedException,
                                                          InvalidParameterException,
                                                          UnrecognizedGUIDException

Get ZoneGovernance relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: ZoneGovernance relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateZoneGovernanceRelationship

public ZoneGovernance updateZoneGovernanceRelationship(String userId,
                                                       ZoneGovernance zoneGovernance)
                                                throws UserNotAuthorizedException,
                                                       MetadataServerUncontactableException,
                                                       InvalidParameterException,
                                                       StatusNotSupportedException,
                                                       UnrecognizedGUIDException

Update ZoneGovernance relationship

Parameters:: userId - user identity; zoneGovernance - relationship
Returns:: ZoneGovernance relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createFolderHierarchyRelationship

public FolderHierarchy createFolderHierarchyRelationship(String userId,
                                                         FolderHierarchy relationship)
                                                  throws MetadataServerUncontactableException,
                                                         UserNotAuthorizedException,
                                                         InvalidParameterException,
                                                         UnrecognizedGUIDException,
                                                         StatusNotSupportedException

Create FolderHierarchy relationship

Parameters:: userId - user identity; relationship - FolderHierarchy relationship to create
Returns:: created FolderHierarchy relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getFolderHierarchyRelationshipByGuid

public FolderHierarchy getFolderHierarchyRelationshipByGuid(String userId,
                                                            String relationshipGuid)
                                                     throws MetadataServerUncontactableException,
                                                            UserNotAuthorizedException,
                                                            InvalidParameterException,
                                                            UnrecognizedGUIDException

Get FolderHierarchy relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: FolderHierarchy relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateFolderHierarchyRelationship

public FolderHierarchy updateFolderHierarchyRelationship(String userId,
                                                         FolderHierarchy folderHierarchy)
                                                  throws UserNotAuthorizedException,
                                                         MetadataServerUncontactableException,
                                                         InvalidParameterException,
                                                         StatusNotSupportedException,
                                                         UnrecognizedGUIDException

Update FolderHierarchy relationship

Parameters:: userId - user identity; folderHierarchy - relationship
Returns:: FolderHierarchy relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createHostClusterMemberRelationship

public HostClusterMember createHostClusterMemberRelationship(String userId,
                                                             HostClusterMember relationship)
                                                      throws MetadataServerUncontactableException,
                                                             UserNotAuthorizedException,
                                                             InvalidParameterException,
                                                             UnrecognizedGUIDException,
                                                             StatusNotSupportedException

Create HostClusterMember relationship

Parameters:: userId - user identity; relationship - HostClusterMember relationship to create
Returns:: created HostClusterMember relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getHostClusterMemberRelationshipByGuid

public HostClusterMember getHostClusterMemberRelationshipByGuid(String userId,
                                                                String relationshipGuid)
                                                         throws MetadataServerUncontactableException,
                                                                UserNotAuthorizedException,
                                                                InvalidParameterException,
                                                                UnrecognizedGUIDException

Get HostClusterMember relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: HostClusterMember relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateHostClusterMemberRelationship

public HostClusterMember updateHostClusterMemberRelationship(String userId,
                                                             HostClusterMember hostClusterMember)
                                                      throws UserNotAuthorizedException,
                                                             MetadataServerUncontactableException,
                                                             InvalidParameterException,
                                                             StatusNotSupportedException,
                                                             UnrecognizedGUIDException

Update HostClusterMember relationship

Parameters:: userId - user identity; hostClusterMember - relationship
Returns:: HostClusterMember relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createLibraryCategoryReferenceRelationship

public LibraryCategoryReference createLibraryCategoryReferenceRelationship(String userId,
                                                                           LibraryCategoryReference relationship)
                                                                    throws MetadataServerUncontactableException,
                                                                           UserNotAuthorizedException,
                                                                           InvalidParameterException,
                                                                           UnrecognizedGUIDException,
                                                                           StatusNotSupportedException

Create LibraryCategoryReference relationship

Parameters:: userId - user identity; relationship - LibraryCategoryReference relationship to create
Returns:: created LibraryCategoryReference relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getLibraryCategoryReferenceRelationshipByGuid

public LibraryCategoryReference getLibraryCategoryReferenceRelationshipByGuid(String userId,
                                                                              String relationshipGuid)
                                                                       throws MetadataServerUncontactableException,
                                                                              UserNotAuthorizedException,
                                                                              InvalidParameterException,
                                                                              UnrecognizedGUIDException

Get LibraryCategoryReference relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: LibraryCategoryReference relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateLibraryCategoryReferenceRelationship

public LibraryCategoryReference updateLibraryCategoryReferenceRelationship(String userId,
                                                                           LibraryCategoryReference libraryCategoryReference)
                                                                    throws UserNotAuthorizedException,
                                                                           MetadataServerUncontactableException,
                                                                           InvalidParameterException,
                                                                           StatusNotSupportedException,
                                                                           UnrecognizedGUIDException

Update LibraryCategoryReference relationship

Parameters:: userId - user identity; libraryCategoryReference - relationship
Returns:: LibraryCategoryReference relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createProjectCharterLinkRelationship

public ProjectCharterLink createProjectCharterLinkRelationship(String userId,
                                                               ProjectCharterLink relationship)
                                                        throws MetadataServerUncontactableException,
                                                               UserNotAuthorizedException,
                                                               InvalidParameterException,
                                                               UnrecognizedGUIDException,
                                                               StatusNotSupportedException

Create ProjectCharterLink relationship

Parameters:: userId - user identity; relationship - ProjectCharterLink relationship to create
Returns:: created ProjectCharterLink relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getProjectCharterLinkRelationshipByGuid

public ProjectCharterLink getProjectCharterLinkRelationshipByGuid(String userId,
                                                                  String relationshipGuid)
                                                           throws MetadataServerUncontactableException,
                                                                  UserNotAuthorizedException,
                                                                  InvalidParameterException,
                                                                  UnrecognizedGUIDException

Get ProjectCharterLink relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: ProjectCharterLink relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateProjectCharterLinkRelationship

public ProjectCharterLink updateProjectCharterLinkRelationship(String userId,
                                                               ProjectCharterLink projectCharterLink)
                                                        throws UserNotAuthorizedException,
                                                               MetadataServerUncontactableException,
                                                               InvalidParameterException,
                                                               StatusNotSupportedException,
                                                               UnrecognizedGUIDException

Update ProjectCharterLink relationship

Parameters:: userId - user identity; projectCharterLink - relationship
Returns:: ProjectCharterLink relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createProfileIdentityRelationship

public ProfileIdentity createProfileIdentityRelationship(String userId,
                                                         ProfileIdentity relationship)
                                                  throws MetadataServerUncontactableException,
                                                         UserNotAuthorizedException,
                                                         InvalidParameterException,
                                                         UnrecognizedGUIDException,
                                                         StatusNotSupportedException

Create ProfileIdentity relationship

Parameters:: userId - user identity; relationship - ProfileIdentity relationship to create
Returns:: created ProfileIdentity relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getProfileIdentityRelationshipByGuid

public ProfileIdentity getProfileIdentityRelationshipByGuid(String userId,
                                                            String relationshipGuid)
                                                     throws MetadataServerUncontactableException,
                                                            UserNotAuthorizedException,
                                                            InvalidParameterException,
                                                            UnrecognizedGUIDException

Get ProfileIdentity relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: ProfileIdentity relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateProfileIdentityRelationship

public ProfileIdentity updateProfileIdentityRelationship(String userId,
                                                         ProfileIdentity profileIdentity)
                                                  throws UserNotAuthorizedException,
                                                         MetadataServerUncontactableException,
                                                         InvalidParameterException,
                                                         StatusNotSupportedException,
                                                         UnrecognizedGUIDException

Update ProfileIdentity relationship

Parameters:: userId - user identity; profileIdentity - relationship
Returns:: ProfileIdentity relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createToDoSourceRelationship

public ToDoSource createToDoSourceRelationship(String userId,
                                               ToDoSource relationship)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               InvalidParameterException,
                                               UnrecognizedGUIDException,
                                               StatusNotSupportedException

Create ToDoSource relationship

Parameters:: userId - user identity; relationship - ToDoSource relationship to create
Returns:: created ToDoSource relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getToDoSourceRelationshipByGuid

public ToDoSource getToDoSourceRelationshipByGuid(String userId,
                                                  String relationshipGuid)
                                           throws MetadataServerUncontactableException,
                                                  UserNotAuthorizedException,
                                                  InvalidParameterException,
                                                  UnrecognizedGUIDException

Get ToDoSource relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: ToDoSource relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateToDoSourceRelationship

public ToDoSource updateToDoSourceRelationship(String userId,
                                               ToDoSource toDoSource)
                                        throws UserNotAuthorizedException,
                                               MetadataServerUncontactableException,
                                               InvalidParameterException,
                                               StatusNotSupportedException,
                                               UnrecognizedGUIDException

Update ToDoSource relationship

Parameters:: userId - user identity; toDoSource - relationship
Returns:: ToDoSource relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createTranslationRelationship

public Translation createTranslationRelationship(String userId,
                                                 Translation relationship)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 UnrecognizedGUIDException,
                                                 StatusNotSupportedException

Create Translation relationship

Parameters:: userId - user identity; relationship - Translation relationship to create
Returns:: created Translation relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getTranslationRelationshipByGuid

public Translation getTranslationRelationshipByGuid(String userId,
                                                    String relationshipGuid)
                                             throws MetadataServerUncontactableException,
                                                    UserNotAuthorizedException,
                                                    InvalidParameterException,
                                                    UnrecognizedGUIDException

Get Translation relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: Translation relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateTranslationRelationship

public Translation updateTranslationRelationship(String userId,
                                                 Translation translation)
                                          throws UserNotAuthorizedException,
                                                 MetadataServerUncontactableException,
                                                 InvalidParameterException,
                                                 StatusNotSupportedException,
                                                 UnrecognizedGUIDException

Update Translation relationship

Parameters:: userId - user identity; translation - relationship
Returns:: Translation relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createSchemaLinkToTypeRelationship

public SchemaLinkToType createSchemaLinkToTypeRelationship(String userId,
                                                           SchemaLinkToType relationship)
                                                    throws MetadataServerUncontactableException,
                                                           UserNotAuthorizedException,
                                                           InvalidParameterException,
                                                           UnrecognizedGUIDException,
                                                           StatusNotSupportedException

Create SchemaLinkToType relationship

Parameters:: userId - user identity; relationship - SchemaLinkToType relationship to create
Returns:: created SchemaLinkToType relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getSchemaLinkToTypeRelationshipByGuid

public SchemaLinkToType getSchemaLinkToTypeRelationshipByGuid(String userId,
                                                              String relationshipGuid)
                                                       throws MetadataServerUncontactableException,
                                                              UserNotAuthorizedException,
                                                              InvalidParameterException,
                                                              UnrecognizedGUIDException

Get SchemaLinkToType relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: SchemaLinkToType relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateSchemaLinkToTypeRelationship

public SchemaLinkToType updateSchemaLinkToTypeRelationship(String userId,
                                                           SchemaLinkToType schemaLinkToType)
                                                    throws UserNotAuthorizedException,
                                                           MetadataServerUncontactableException,
                                                           InvalidParameterException,
                                                           StatusNotSupportedException,
                                                           UnrecognizedGUIDException

Update SchemaLinkToType relationship

Parameters:: userId - user identity; schemaLinkToType - relationship
Returns:: SchemaLinkToType relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createDataContentForDataSetRelationship

public DataContentForDataSet createDataContentForDataSetRelationship(String userId,
                                                                     DataContentForDataSet relationship)
                                                              throws MetadataServerUncontactableException,
                                                                     UserNotAuthorizedException,
                                                                     InvalidParameterException,
                                                                     UnrecognizedGUIDException,
                                                                     StatusNotSupportedException

Create DataContentForDataSet relationship

Parameters:: userId - user identity; relationship - DataContentForDataSet relationship to create
Returns:: created DataContentForDataSet relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getDataContentForDataSetRelationshipByGuid

public DataContentForDataSet getDataContentForDataSetRelationshipByGuid(String userId,
                                                                        String relationshipGuid)
                                                                 throws MetadataServerUncontactableException,
                                                                        UserNotAuthorizedException,
                                                                        InvalidParameterException,
                                                                        UnrecognizedGUIDException

Get DataContentForDataSet relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: DataContentForDataSet relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateDataContentForDataSetRelationship

public DataContentForDataSet updateDataContentForDataSetRelationship(String userId,
                                                                     DataContentForDataSet dataContentForDataSet)
                                                              throws UserNotAuthorizedException,
                                                                     MetadataServerUncontactableException,
                                                                     InvalidParameterException,
                                                                     StatusNotSupportedException,
                                                                     UnrecognizedGUIDException

Update DataContentForDataSet relationship

Parameters:: userId - user identity; dataContentForDataSet - relationship
Returns:: DataContentForDataSet relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createServerEndpointRelationship

public ServerEndpoint createServerEndpointRelationship(String userId,
                                                       ServerEndpoint relationship)
                                                throws MetadataServerUncontactableException,
                                                       UserNotAuthorizedException,
                                                       InvalidParameterException,
                                                       UnrecognizedGUIDException,
                                                       StatusNotSupportedException

Create ServerEndpoint relationship

Parameters:: userId - user identity; relationship - ServerEndpoint relationship to create
Returns:: created ServerEndpoint relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getServerEndpointRelationshipByGuid

public ServerEndpoint getServerEndpointRelationshipByGuid(String userId,
                                                          String relationshipGuid)
                                                   throws MetadataServerUncontactableException,
                                                          UserNotAuthorizedException,
                                                          InvalidParameterException,
                                                          UnrecognizedGUIDException

Get ServerEndpoint relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: ServerEndpoint relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateServerEndpointRelationship

public ServerEndpoint updateServerEndpointRelationship(String userId,
                                                       ServerEndpoint serverEndpoint)
                                                throws UserNotAuthorizedException,
                                                       MetadataServerUncontactableException,
                                                       InvalidParameterException,
                                                       StatusNotSupportedException,
                                                       UnrecognizedGUIDException

Update ServerEndpoint relationship

Parameters:: userId - user identity; serverEndpoint - relationship
Returns:: ServerEndpoint relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createExternalIdLinkRelationship

public ExternalIdLink createExternalIdLinkRelationship(String userId,
                                                       ExternalIdLink relationship)
                                                throws MetadataServerUncontactableException,
                                                       UserNotAuthorizedException,
                                                       InvalidParameterException,
                                                       UnrecognizedGUIDException,
                                                       StatusNotSupportedException

Create ExternalIdLink relationship

Parameters:: userId - user identity; relationship - ExternalIdLink relationship to create
Returns:: created ExternalIdLink relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getExternalIdLinkRelationshipByGuid

public ExternalIdLink getExternalIdLinkRelationshipByGuid(String userId,
                                                          String relationshipGuid)
                                                   throws MetadataServerUncontactableException,
                                                          UserNotAuthorizedException,
                                                          InvalidParameterException,
                                                          UnrecognizedGUIDException

Get ExternalIdLink relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: ExternalIdLink relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateExternalIdLinkRelationship

public ExternalIdLink updateExternalIdLinkRelationship(String userId,
                                                       ExternalIdLink externalIdLink)
                                                throws UserNotAuthorizedException,
                                                       MetadataServerUncontactableException,
                                                       InvalidParameterException,
                                                       StatusNotSupportedException,
                                                       UnrecognizedGUIDException

Update ExternalIdLink relationship

Parameters:: userId - user identity; externalIdLink - relationship
Returns:: ExternalIdLink relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createCategoryHierarchyLinkRelationship

public CategoryHierarchyLink createCategoryHierarchyLinkRelationship(String userId,
                                                                     CategoryHierarchyLink relationship)
                                                              throws MetadataServerUncontactableException,
                                                                     UserNotAuthorizedException,
                                                                     InvalidParameterException,
                                                                     UnrecognizedGUIDException,
                                                                     StatusNotSupportedException

Create CategoryHierarchyLink relationship

Parameters:: userId - user identity; relationship - CategoryHierarchyLink relationship to create
Returns:: created CategoryHierarchyLink relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getCategoryHierarchyLinkRelationshipByGuid

public CategoryHierarchyLink getCategoryHierarchyLinkRelationshipByGuid(String userId,
                                                                        String relationshipGuid)
                                                                 throws MetadataServerUncontactableException,
                                                                        UserNotAuthorizedException,
                                                                        InvalidParameterException,
                                                                        UnrecognizedGUIDException

Get CategoryHierarchyLink relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: CategoryHierarchyLink relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateCategoryHierarchyLinkRelationship

public CategoryHierarchyLink updateCategoryHierarchyLinkRelationship(String userId,
                                                                     CategoryHierarchyLink categoryHierarchyLink)
                                                              throws UserNotAuthorizedException,
                                                                     MetadataServerUncontactableException,
                                                                     InvalidParameterException,
                                                                     StatusNotSupportedException,
                                                                     UnrecognizedGUIDException

Update CategoryHierarchyLink relationship

Parameters:: userId - user identity; categoryHierarchyLink - relationship
Returns:: CategoryHierarchyLink relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createPreferredTermRelationship

public PreferredTerm createPreferredTermRelationship(String userId,
                                                     PreferredTerm relationship)
                                              throws MetadataServerUncontactableException,
                                                     UserNotAuthorizedException,
                                                     InvalidParameterException,
                                                     UnrecognizedGUIDException,
                                                     StatusNotSupportedException

Create PreferredTerm relationship

Parameters:: userId - user identity; relationship - PreferredTerm relationship to create
Returns:: created PreferredTerm relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getPreferredTermRelationshipByGuid

public PreferredTerm getPreferredTermRelationshipByGuid(String userId,
                                                        String relationshipGuid)
                                                 throws MetadataServerUncontactableException,
                                                        UserNotAuthorizedException,
                                                        InvalidParameterException,
                                                        UnrecognizedGUIDException

Get PreferredTerm relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: PreferredTerm relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updatePreferredTermRelationship

public PreferredTerm updatePreferredTermRelationship(String userId,
                                                     PreferredTerm preferredTerm)
                                              throws UserNotAuthorizedException,
                                                     MetadataServerUncontactableException,
                                                     InvalidParameterException,
                                                     StatusNotSupportedException,
                                                     UnrecognizedGUIDException

Update PreferredTerm relationship

Parameters:: userId - user identity; preferredTerm - relationship
Returns:: PreferredTerm relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createProjectHierarchyRelationship

public ProjectHierarchy createProjectHierarchyRelationship(String userId,
                                                           ProjectHierarchy relationship)
                                                    throws MetadataServerUncontactableException,
                                                           UserNotAuthorizedException,
                                                           InvalidParameterException,
                                                           UnrecognizedGUIDException,
                                                           StatusNotSupportedException

Create ProjectHierarchy relationship

Parameters:: userId - user identity; relationship - ProjectHierarchy relationship to create
Returns:: created ProjectHierarchy relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getProjectHierarchyRelationshipByGuid

public ProjectHierarchy getProjectHierarchyRelationshipByGuid(String userId,
                                                              String relationshipGuid)
                                                       throws MetadataServerUncontactableException,
                                                              UserNotAuthorizedException,
                                                              InvalidParameterException,
                                                              UnrecognizedGUIDException

Get ProjectHierarchy relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: ProjectHierarchy relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateProjectHierarchyRelationship

public ProjectHierarchy updateProjectHierarchyRelationship(String userId,
                                                           ProjectHierarchy projectHierarchy)
                                                    throws UserNotAuthorizedException,
                                                           MetadataServerUncontactableException,
                                                           InvalidParameterException,
                                                           StatusNotSupportedException,
                                                           UnrecognizedGUIDException

Update ProjectHierarchy relationship

Parameters:: userId - user identity; projectHierarchy - relationship
Returns:: ProjectHierarchy relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createDeployedVirtualContainerRelationship

public DeployedVirtualContainer createDeployedVirtualContainerRelationship(String userId,
                                                                           DeployedVirtualContainer relationship)
                                                                    throws MetadataServerUncontactableException,
                                                                           UserNotAuthorizedException,
                                                                           InvalidParameterException,
                                                                           UnrecognizedGUIDException,
                                                                           StatusNotSupportedException

Create DeployedVirtualContainer relationship

Parameters:: userId - user identity; relationship - DeployedVirtualContainer relationship to create
Returns:: created DeployedVirtualContainer relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getDeployedVirtualContainerRelationshipByGuid

public DeployedVirtualContainer getDeployedVirtualContainerRelationshipByGuid(String userId,
                                                                              String relationshipGuid)
                                                                       throws MetadataServerUncontactableException,
                                                                              UserNotAuthorizedException,
                                                                              InvalidParameterException,
                                                                              UnrecognizedGUIDException

Get DeployedVirtualContainer relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: DeployedVirtualContainer relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateDeployedVirtualContainerRelationship

public DeployedVirtualContainer updateDeployedVirtualContainerRelationship(String userId,
                                                                           DeployedVirtualContainer deployedVirtualContainer)
                                                                    throws UserNotAuthorizedException,
                                                                           MetadataServerUncontactableException,
                                                                           InvalidParameterException,
                                                                           StatusNotSupportedException,
                                                                           UnrecognizedGUIDException

Update DeployedVirtualContainer relationship

Parameters:: userId - user identity; deployedVirtualContainer - relationship
Returns:: DeployedVirtualContainer relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createGovernanceResultsRelationship

public GovernanceResults createGovernanceResultsRelationship(String userId,
                                                             GovernanceResults relationship)
                                                      throws MetadataServerUncontactableException,
                                                             UserNotAuthorizedException,
                                                             InvalidParameterException,
                                                             UnrecognizedGUIDException,
                                                             StatusNotSupportedException

Create GovernanceResults relationship

Parameters:: userId - user identity; relationship - GovernanceResults relationship to create
Returns:: created GovernanceResults relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getGovernanceResultsRelationshipByGuid

public GovernanceResults getGovernanceResultsRelationshipByGuid(String userId,
                                                                String relationshipGuid)
                                                         throws MetadataServerUncontactableException,
                                                                UserNotAuthorizedException,
                                                                InvalidParameterException,
                                                                UnrecognizedGUIDException

Get GovernanceResults relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: GovernanceResults relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateGovernanceResultsRelationship

public GovernanceResults updateGovernanceResultsRelationship(String userId,
                                                             GovernanceResults governanceResults)
                                                      throws UserNotAuthorizedException,
                                                             MetadataServerUncontactableException,
                                                             InvalidParameterException,
                                                             StatusNotSupportedException,
                                                             UnrecognizedGUIDException

Update GovernanceResults relationship

Parameters:: userId - user identity; governanceResults - relationship
Returns:: GovernanceResults relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createAPIResponseRelationship

public APIResponse createAPIResponseRelationship(String userId,
                                                 APIResponse relationship)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 UnrecognizedGUIDException,
                                                 StatusNotSupportedException

Create APIResponse relationship

Parameters:: userId - user identity; relationship - APIResponse relationship to create
Returns:: created APIResponse relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getAPIResponseRelationshipByGuid

public APIResponse getAPIResponseRelationshipByGuid(String userId,
                                                    String relationshipGuid)
                                             throws MetadataServerUncontactableException,
                                                    UserNotAuthorizedException,
                                                    InvalidParameterException,
                                                    UnrecognizedGUIDException

Get APIResponse relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: APIResponse relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateAPIResponseRelationship

public APIResponse updateAPIResponseRelationship(String userId,
                                                 APIResponse aPIResponse)
                                          throws UserNotAuthorizedException,
                                                 MetadataServerUncontactableException,
                                                 InvalidParameterException,
                                                 StatusNotSupportedException,
                                                 UnrecognizedGUIDException

Update APIResponse relationship

Parameters:: userId - user identity; aPIResponse - relationship
Returns:: APIResponse relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createHostNetworkRelationship

public HostNetwork createHostNetworkRelationship(String userId,
                                                 HostNetwork relationship)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 UnrecognizedGUIDException,
                                                 StatusNotSupportedException

Create HostNetwork relationship

Parameters:: userId - user identity; relationship - HostNetwork relationship to create
Returns:: created HostNetwork relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getHostNetworkRelationshipByGuid

public HostNetwork getHostNetworkRelationshipByGuid(String userId,
                                                    String relationshipGuid)
                                             throws MetadataServerUncontactableException,
                                                    UserNotAuthorizedException,
                                                    InvalidParameterException,
                                                    UnrecognizedGUIDException

Get HostNetwork relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: HostNetwork relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateHostNetworkRelationship

public HostNetwork updateHostNetworkRelationship(String userId,
                                                 HostNetwork hostNetwork)
                                          throws UserNotAuthorizedException,
                                                 MetadataServerUncontactableException,
                                                 InvalidParameterException,
                                                 StatusNotSupportedException,
                                                 UnrecognizedGUIDException

Update HostNetwork relationship

Parameters:: userId - user identity; hostNetwork - relationship
Returns:: HostNetwork relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createAttributeForSchemaRelationship

public AttributeForSchema createAttributeForSchemaRelationship(String userId,
                                                               AttributeForSchema relationship)
                                                        throws MetadataServerUncontactableException,
                                                               UserNotAuthorizedException,
                                                               InvalidParameterException,
                                                               UnrecognizedGUIDException,
                                                               StatusNotSupportedException

Create AttributeForSchema relationship

Parameters:: userId - user identity; relationship - AttributeForSchema relationship to create
Returns:: created AttributeForSchema relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getAttributeForSchemaRelationshipByGuid

public AttributeForSchema getAttributeForSchemaRelationshipByGuid(String userId,
                                                                  String relationshipGuid)
                                                           throws MetadataServerUncontactableException,
                                                                  UserNotAuthorizedException,
                                                                  InvalidParameterException,
                                                                  UnrecognizedGUIDException

Get AttributeForSchema relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: AttributeForSchema relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateAttributeForSchemaRelationship

public AttributeForSchema updateAttributeForSchemaRelationship(String userId,
                                                               AttributeForSchema attributeForSchema)
                                                        throws UserNotAuthorizedException,
                                                               MetadataServerUncontactableException,
                                                               InvalidParameterException,
                                                               StatusNotSupportedException,
                                                               UnrecognizedGUIDException

Update AttributeForSchema relationship

Parameters:: userId - user identity; attributeForSchema - relationship
Returns:: AttributeForSchema relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createAssetLocationRelationship

public AssetLocation createAssetLocationRelationship(String userId,
                                                     AssetLocation relationship)
                                              throws MetadataServerUncontactableException,
                                                     UserNotAuthorizedException,
                                                     InvalidParameterException,
                                                     UnrecognizedGUIDException,
                                                     StatusNotSupportedException

Create AssetLocation relationship

Parameters:: userId - user identity; relationship - AssetLocation relationship to create
Returns:: created AssetLocation relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getAssetLocationRelationshipByGuid

public AssetLocation getAssetLocationRelationshipByGuid(String userId,
                                                        String relationshipGuid)
                                                 throws MetadataServerUncontactableException,
                                                        UserNotAuthorizedException,
                                                        InvalidParameterException,
                                                        UnrecognizedGUIDException

Get AssetLocation relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: AssetLocation relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateAssetLocationRelationship

public AssetLocation updateAssetLocationRelationship(String userId,
                                                     AssetLocation assetLocation)
                                              throws UserNotAuthorizedException,
                                                     MetadataServerUncontactableException,
                                                     InvalidParameterException,
                                                     StatusNotSupportedException,
                                                     UnrecognizedGUIDException

Update AssetLocation relationship

Parameters:: userId - user identity; assetLocation - relationship
Returns:: AssetLocation relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createSchemaAttributeTypeRelationship

public SchemaAttributeType createSchemaAttributeTypeRelationship(String userId,
                                                                 SchemaAttributeType relationship)
                                                          throws MetadataServerUncontactableException,
                                                                 UserNotAuthorizedException,
                                                                 InvalidParameterException,
                                                                 UnrecognizedGUIDException,
                                                                 StatusNotSupportedException

Create SchemaAttributeType relationship

Parameters:: userId - user identity; relationship - SchemaAttributeType relationship to create
Returns:: created SchemaAttributeType relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getSchemaAttributeTypeRelationshipByGuid

public SchemaAttributeType getSchemaAttributeTypeRelationshipByGuid(String userId,
                                                                    String relationshipGuid)
                                                             throws MetadataServerUncontactableException,
                                                                    UserNotAuthorizedException,
                                                                    InvalidParameterException,
                                                                    UnrecognizedGUIDException

Get SchemaAttributeType relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: SchemaAttributeType relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateSchemaAttributeTypeRelationship

public SchemaAttributeType updateSchemaAttributeTypeRelationship(String userId,
                                                                 SchemaAttributeType schemaAttributeType)
                                                          throws UserNotAuthorizedException,
                                                                 MetadataServerUncontactableException,
                                                                 InvalidParameterException,
                                                                 StatusNotSupportedException,
                                                                 UnrecognizedGUIDException

Update SchemaAttributeType relationship

Parameters:: userId - user identity; schemaAttributeType - relationship
Returns:: SchemaAttributeType relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createGovernanceImplementationRelationship

public GovernanceImplementation createGovernanceImplementationRelationship(String userId,
                                                                           GovernanceImplementation relationship)
                                                                    throws MetadataServerUncontactableException,
                                                                           UserNotAuthorizedException,
                                                                           InvalidParameterException,
                                                                           UnrecognizedGUIDException,
                                                                           StatusNotSupportedException

Create GovernanceImplementation relationship

Parameters:: userId - user identity; relationship - GovernanceImplementation relationship to create
Returns:: created GovernanceImplementation relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getGovernanceImplementationRelationshipByGuid

public GovernanceImplementation getGovernanceImplementationRelationshipByGuid(String userId,
                                                                              String relationshipGuid)
                                                                       throws MetadataServerUncontactableException,
                                                                              UserNotAuthorizedException,
                                                                              InvalidParameterException,
                                                                              UnrecognizedGUIDException

Get GovernanceImplementation relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: GovernanceImplementation relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateGovernanceImplementationRelationship

public GovernanceImplementation updateGovernanceImplementationRelationship(String userId,
                                                                           GovernanceImplementation governanceImplementation)
                                                                    throws UserNotAuthorizedException,
                                                                           MetadataServerUncontactableException,
                                                                           InvalidParameterException,
                                                                           StatusNotSupportedException,
                                                                           UnrecognizedGUIDException

Update GovernanceImplementation relationship

Parameters:: userId - user identity; governanceImplementation - relationship
Returns:: GovernanceImplementation relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createLinkedMediaRelationship

public LinkedMedia createLinkedMediaRelationship(String userId,
                                                 LinkedMedia relationship)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 UnrecognizedGUIDException,
                                                 StatusNotSupportedException

Create LinkedMedia relationship

Parameters:: userId - user identity; relationship - LinkedMedia relationship to create
Returns:: created LinkedMedia relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getLinkedMediaRelationshipByGuid

public LinkedMedia getLinkedMediaRelationshipByGuid(String userId,
                                                    String relationshipGuid)
                                             throws MetadataServerUncontactableException,
                                                    UserNotAuthorizedException,
                                                    InvalidParameterException,
                                                    UnrecognizedGUIDException

Get LinkedMedia relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: LinkedMedia relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateLinkedMediaRelationship

public LinkedMedia updateLinkedMediaRelationship(String userId,
                                                 LinkedMedia linkedMedia)
                                          throws UserNotAuthorizedException,
                                                 MetadataServerUncontactableException,
                                                 InvalidParameterException,
                                                 StatusNotSupportedException,
                                                 UnrecognizedGUIDException

Update LinkedMedia relationship

Parameters:: userId - user identity; linkedMedia - relationship
Returns:: LinkedMedia relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createMapToElementTypeRelationship

public MapToElementType createMapToElementTypeRelationship(String userId,
                                                           MapToElementType relationship)
                                                    throws MetadataServerUncontactableException,
                                                           UserNotAuthorizedException,
                                                           InvalidParameterException,
                                                           UnrecognizedGUIDException,
                                                           StatusNotSupportedException

Create MapToElementType relationship

Parameters:: userId - user identity; relationship - MapToElementType relationship to create
Returns:: created MapToElementType relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getMapToElementTypeRelationshipByGuid

public MapToElementType getMapToElementTypeRelationshipByGuid(String userId,
                                                              String relationshipGuid)
                                                       throws MetadataServerUncontactableException,
                                                              UserNotAuthorizedException,
                                                              InvalidParameterException,
                                                              UnrecognizedGUIDException

Get MapToElementType relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: MapToElementType relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateMapToElementTypeRelationship

public MapToElementType updateMapToElementTypeRelationship(String userId,
                                                           MapToElementType mapToElementType)
                                                    throws UserNotAuthorizedException,
                                                           MetadataServerUncontactableException,
                                                           InvalidParameterException,
                                                           StatusNotSupportedException,
                                                           UnrecognizedGUIDException

Update MapToElementType relationship

Parameters:: userId - user identity; mapToElementType - relationship
Returns:: MapToElementType relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createExternallySourcedGlossaryRelationship

public ExternallySourcedGlossary createExternallySourcedGlossaryRelationship(String userId,
                                                                             ExternallySourcedGlossary relationship)
                                                                      throws MetadataServerUncontactableException,
                                                                             UserNotAuthorizedException,
                                                                             InvalidParameterException,
                                                                             UnrecognizedGUIDException,
                                                                             StatusNotSupportedException

Create ExternallySourcedGlossary relationship

Parameters:: userId - user identity; relationship - ExternallySourcedGlossary relationship to create
Returns:: created ExternallySourcedGlossary relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getExternallySourcedGlossaryRelationshipByGuid

public ExternallySourcedGlossary getExternallySourcedGlossaryRelationshipByGuid(String userId,
                                                                                String relationshipGuid)
                                                                         throws MetadataServerUncontactableException,
                                                                                UserNotAuthorizedException,
                                                                                InvalidParameterException,
                                                                                UnrecognizedGUIDException

Get ExternallySourcedGlossary relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: ExternallySourcedGlossary relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateExternallySourcedGlossaryRelationship

public ExternallySourcedGlossary updateExternallySourcedGlossaryRelationship(String userId,
                                                                             ExternallySourcedGlossary externallySourcedGlossary)
                                                                      throws UserNotAuthorizedException,
                                                                             MetadataServerUncontactableException,
                                                                             InvalidParameterException,
                                                                             StatusNotSupportedException,
                                                                             UnrecognizedGUIDException

Update ExternallySourcedGlossary relationship

Parameters:: userId - user identity; externallySourcedGlossary - relationship
Returns:: ExternallySourcedGlossary relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createExternalReferenceLinkRelationship

public ExternalReferenceLink createExternalReferenceLinkRelationship(String userId,
                                                                     ExternalReferenceLink relationship)
                                                              throws MetadataServerUncontactableException,
                                                                     UserNotAuthorizedException,
                                                                     InvalidParameterException,
                                                                     UnrecognizedGUIDException,
                                                                     StatusNotSupportedException

Create ExternalReferenceLink relationship

Parameters:: userId - user identity; relationship - ExternalReferenceLink relationship to create
Returns:: created ExternalReferenceLink relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getExternalReferenceLinkRelationshipByGuid

public ExternalReferenceLink getExternalReferenceLinkRelationshipByGuid(String userId,
                                                                        String relationshipGuid)
                                                                 throws MetadataServerUncontactableException,
                                                                        UserNotAuthorizedException,
                                                                        InvalidParameterException,
                                                                        UnrecognizedGUIDException

Get ExternalReferenceLink relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: ExternalReferenceLink relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateExternalReferenceLinkRelationship

public ExternalReferenceLink updateExternalReferenceLinkRelationship(String userId,
                                                                     ExternalReferenceLink externalReferenceLink)
                                                              throws UserNotAuthorizedException,
                                                                     MetadataServerUncontactableException,
                                                                     InvalidParameterException,
                                                                     StatusNotSupportedException,
                                                                     UnrecognizedGUIDException

Update ExternalReferenceLink relationship

Parameters:: userId - user identity; externalReferenceLink - relationship
Returns:: ExternalReferenceLink relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createMediaReferenceRelationship

public MediaReference createMediaReferenceRelationship(String userId,
                                                       MediaReference relationship)
                                                throws MetadataServerUncontactableException,
                                                       UserNotAuthorizedException,
                                                       InvalidParameterException,
                                                       UnrecognizedGUIDException,
                                                       StatusNotSupportedException

Create MediaReference relationship

Parameters:: userId - user identity; relationship - MediaReference relationship to create
Returns:: created MediaReference relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getMediaReferenceRelationshipByGuid

public MediaReference getMediaReferenceRelationshipByGuid(String userId,
                                                          String relationshipGuid)
                                                   throws MetadataServerUncontactableException,
                                                          UserNotAuthorizedException,
                                                          InvalidParameterException,
                                                          UnrecognizedGUIDException

Get MediaReference relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: MediaReference relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateMediaReferenceRelationship

public MediaReference updateMediaReferenceRelationship(String userId,
                                                       MediaReference mediaReference)
                                                throws UserNotAuthorizedException,
                                                       MetadataServerUncontactableException,
                                                       InvalidParameterException,
                                                       StatusNotSupportedException,
                                                       UnrecognizedGUIDException

Update MediaReference relationship

Parameters:: userId - user identity; mediaReference - relationship
Returns:: MediaReference relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createCommunityMembershipRelationship

public CommunityMembership createCommunityMembershipRelationship(String userId,
                                                                 CommunityMembership relationship)
                                                          throws MetadataServerUncontactableException,
                                                                 UserNotAuthorizedException,
                                                                 InvalidParameterException,
                                                                 UnrecognizedGUIDException,
                                                                 StatusNotSupportedException

Create CommunityMembership relationship

Parameters:: userId - user identity; relationship - CommunityMembership relationship to create
Returns:: created CommunityMembership relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getCommunityMembershipRelationshipByGuid

public CommunityMembership getCommunityMembershipRelationshipByGuid(String userId,
                                                                    String relationshipGuid)
                                                             throws MetadataServerUncontactableException,
                                                                    UserNotAuthorizedException,
                                                                    InvalidParameterException,
                                                                    UnrecognizedGUIDException

Get CommunityMembership relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: CommunityMembership relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateCommunityMembershipRelationship

public CommunityMembership updateCommunityMembershipRelationship(String userId,
                                                                 CommunityMembership communityMembership)
                                                          throws UserNotAuthorizedException,
                                                                 MetadataServerUncontactableException,
                                                                 InvalidParameterException,
                                                                 StatusNotSupportedException,
                                                                 UnrecognizedGUIDException

Update CommunityMembership relationship

Parameters:: userId - user identity; communityMembership - relationship
Returns:: CommunityMembership relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createExternalIdScopeRelationship

public ExternalIdScope createExternalIdScopeRelationship(String userId,
                                                         ExternalIdScope relationship)
                                                  throws MetadataServerUncontactableException,
                                                         UserNotAuthorizedException,
                                                         InvalidParameterException,
                                                         UnrecognizedGUIDException,
                                                         StatusNotSupportedException

Create ExternalIdScope relationship

Parameters:: userId - user identity; relationship - ExternalIdScope relationship to create
Returns:: created ExternalIdScope relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getExternalIdScopeRelationshipByGuid

public ExternalIdScope getExternalIdScopeRelationshipByGuid(String userId,
                                                            String relationshipGuid)
                                                     throws MetadataServerUncontactableException,
                                                            UserNotAuthorizedException,
                                                            InvalidParameterException,
                                                            UnrecognizedGUIDException

Get ExternalIdScope relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: ExternalIdScope relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateExternalIdScopeRelationship

public ExternalIdScope updateExternalIdScopeRelationship(String userId,
                                                         ExternalIdScope externalIdScope)
                                                  throws UserNotAuthorizedException,
                                                         MetadataServerUncontactableException,
                                                         InvalidParameterException,
                                                         StatusNotSupportedException,
                                                         UnrecognizedGUIDException

Update ExternalIdScope relationship

Parameters:: userId - user identity; externalIdScope - relationship
Returns:: ExternalIdScope relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createValidValueRelationship

public ValidValue createValidValueRelationship(String userId,
                                               ValidValue relationship)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               InvalidParameterException,
                                               UnrecognizedGUIDException,
                                               StatusNotSupportedException

Create ValidValue relationship

Parameters:: userId - user identity; relationship - ValidValue relationship to create
Returns:: created ValidValue relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getValidValueRelationshipByGuid

public ValidValue getValidValueRelationshipByGuid(String userId,
                                                  String relationshipGuid)
                                           throws MetadataServerUncontactableException,
                                                  UserNotAuthorizedException,
                                                  InvalidParameterException,
                                                  UnrecognizedGUIDException

Get ValidValue relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: ValidValue relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateValidValueRelationship

public ValidValue updateValidValueRelationship(String userId,
                                               ValidValue validValue)
                                        throws UserNotAuthorizedException,
                                               MetadataServerUncontactableException,
                                               InvalidParameterException,
                                               StatusNotSupportedException,
                                               UnrecognizedGUIDException

Update ValidValue relationship

Parameters:: userId - user identity; validValue - relationship
Returns:: ValidValue relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createAcceptedAnswerRelationship

public AcceptedAnswer createAcceptedAnswerRelationship(String userId,
                                                       AcceptedAnswer relationship)
                                                throws MetadataServerUncontactableException,
                                                       UserNotAuthorizedException,
                                                       InvalidParameterException,
                                                       UnrecognizedGUIDException,
                                                       StatusNotSupportedException

Create AcceptedAnswer relationship

Parameters:: userId - user identity; relationship - AcceptedAnswer relationship to create
Returns:: created AcceptedAnswer relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getAcceptedAnswerRelationshipByGuid

public AcceptedAnswer getAcceptedAnswerRelationshipByGuid(String userId,
                                                          String relationshipGuid)
                                                   throws MetadataServerUncontactableException,
                                                          UserNotAuthorizedException,
                                                          InvalidParameterException,
                                                          UnrecognizedGUIDException

Get AcceptedAnswer relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: AcceptedAnswer relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateAcceptedAnswerRelationship

public AcceptedAnswer updateAcceptedAnswerRelationship(String userId,
                                                       AcceptedAnswer acceptedAnswer)
                                                throws UserNotAuthorizedException,
                                                       MetadataServerUncontactableException,
                                                       InvalidParameterException,
                                                       StatusNotSupportedException,
                                                       UnrecognizedGUIDException

Update AcceptedAnswer relationship

Parameters:: userId - user identity; acceptedAnswer - relationship
Returns:: AcceptedAnswer relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createGovernanceDefinitionMetricRelationship

public GovernanceDefinitionMetric createGovernanceDefinitionMetricRelationship(String userId,
                                                                               GovernanceDefinitionMetric relationship)
                                                                        throws MetadataServerUncontactableException,
                                                                               UserNotAuthorizedException,
                                                                               InvalidParameterException,
                                                                               UnrecognizedGUIDException,
                                                                               StatusNotSupportedException

Create GovernanceDefinitionMetric relationship

Parameters:: userId - user identity; relationship - GovernanceDefinitionMetric relationship to create
Returns:: created GovernanceDefinitionMetric relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getGovernanceDefinitionMetricRelationshipByGuid

public GovernanceDefinitionMetric getGovernanceDefinitionMetricRelationshipByGuid(String userId,
                                                                                  String relationshipGuid)
                                                                           throws MetadataServerUncontactableException,
                                                                                  UserNotAuthorizedException,
                                                                                  InvalidParameterException,
                                                                                  UnrecognizedGUIDException

Get GovernanceDefinitionMetric relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: GovernanceDefinitionMetric relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateGovernanceDefinitionMetricRelationship

public GovernanceDefinitionMetric updateGovernanceDefinitionMetricRelationship(String userId,
                                                                               GovernanceDefinitionMetric governanceDefinitionMetric)
                                                                        throws UserNotAuthorizedException,
                                                                               MetadataServerUncontactableException,
                                                                               InvalidParameterException,
                                                                               StatusNotSupportedException,
                                                                               UnrecognizedGUIDException

Update GovernanceDefinitionMetric relationship

Parameters:: userId - user identity; governanceDefinitionMetric - relationship
Returns:: GovernanceDefinitionMetric relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createSchemaQueryImplementationRelationship

public SchemaQueryImplementation createSchemaQueryImplementationRelationship(String userId,
                                                                             SchemaQueryImplementation relationship)
                                                                      throws MetadataServerUncontactableException,
                                                                             UserNotAuthorizedException,
                                                                             InvalidParameterException,
                                                                             UnrecognizedGUIDException,
                                                                             StatusNotSupportedException

Create SchemaQueryImplementation relationship

Parameters:: userId - user identity; relationship - SchemaQueryImplementation relationship to create
Returns:: created SchemaQueryImplementation relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getSchemaQueryImplementationRelationshipByGuid

public SchemaQueryImplementation getSchemaQueryImplementationRelationshipByGuid(String userId,
                                                                                String relationshipGuid)
                                                                         throws MetadataServerUncontactableException,
                                                                                UserNotAuthorizedException,
                                                                                InvalidParameterException,
                                                                                UnrecognizedGUIDException

Get SchemaQueryImplementation relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: SchemaQueryImplementation relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateSchemaQueryImplementationRelationship

public SchemaQueryImplementation updateSchemaQueryImplementationRelationship(String userId,
                                                                             SchemaQueryImplementation schemaQueryImplementation)
                                                                      throws UserNotAuthorizedException,
                                                                             MetadataServerUncontactableException,
                                                                             InvalidParameterException,
                                                                             StatusNotSupportedException,
                                                                             UnrecognizedGUIDException

Update SchemaQueryImplementation relationship

Parameters:: userId - user identity; schemaQueryImplementation - relationship
Returns:: SchemaQueryImplementation relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createAssetSchemaTypeRelationship

public AssetSchemaType createAssetSchemaTypeRelationship(String userId,
                                                         AssetSchemaType relationship)
                                                  throws MetadataServerUncontactableException,
                                                         UserNotAuthorizedException,
                                                         InvalidParameterException,
                                                         UnrecognizedGUIDException,
                                                         StatusNotSupportedException

Create AssetSchemaType relationship

Parameters:: userId - user identity; relationship - AssetSchemaType relationship to create
Returns:: created AssetSchemaType relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getAssetSchemaTypeRelationshipByGuid

public AssetSchemaType getAssetSchemaTypeRelationshipByGuid(String userId,
                                                            String relationshipGuid)
                                                     throws MetadataServerUncontactableException,
                                                            UserNotAuthorizedException,
                                                            InvalidParameterException,
                                                            UnrecognizedGUIDException

Get AssetSchemaType relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: AssetSchemaType relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateAssetSchemaTypeRelationship

public AssetSchemaType updateAssetSchemaTypeRelationship(String userId,
                                                         AssetSchemaType assetSchemaType)
                                                  throws UserNotAuthorizedException,
                                                         MetadataServerUncontactableException,
                                                         InvalidParameterException,
                                                         StatusNotSupportedException,
                                                         UnrecognizedGUIDException

Update AssetSchemaType relationship

Parameters:: userId - user identity; assetSchemaType - relationship
Returns:: AssetSchemaType relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createProjectDependencyRelationship

public ProjectDependency createProjectDependencyRelationship(String userId,
                                                             ProjectDependency relationship)
                                                      throws MetadataServerUncontactableException,
                                                             UserNotAuthorizedException,
                                                             InvalidParameterException,
                                                             UnrecognizedGUIDException,
                                                             StatusNotSupportedException

Create ProjectDependency relationship

Parameters:: userId - user identity; relationship - ProjectDependency relationship to create
Returns:: created ProjectDependency relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getProjectDependencyRelationshipByGuid

public ProjectDependency getProjectDependencyRelationshipByGuid(String userId,
                                                                String relationshipGuid)
                                                         throws MetadataServerUncontactableException,
                                                                UserNotAuthorizedException,
                                                                InvalidParameterException,
                                                                UnrecognizedGUIDException

Get ProjectDependency relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: ProjectDependency relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateProjectDependencyRelationship

public ProjectDependency updateProjectDependencyRelationship(String userId,
                                                             ProjectDependency projectDependency)
                                                      throws UserNotAuthorizedException,
                                                             MetadataServerUncontactableException,
                                                             InvalidParameterException,
                                                             StatusNotSupportedException,
                                                             UnrecognizedGUIDException

Update ProjectDependency relationship

Parameters:: userId - user identity; projectDependency - relationship
Returns:: ProjectDependency relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createTopicSubscribersRelationship

public TopicSubscribers createTopicSubscribersRelationship(String userId,
                                                           TopicSubscribers relationship)
                                                    throws MetadataServerUncontactableException,
                                                           UserNotAuthorizedException,
                                                           InvalidParameterException,
                                                           UnrecognizedGUIDException,
                                                           StatusNotSupportedException

Create TopicSubscribers relationship

Parameters:: userId - user identity; relationship - TopicSubscribers relationship to create
Returns:: created TopicSubscribers relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getTopicSubscribersRelationshipByGuid

public TopicSubscribers getTopicSubscribersRelationshipByGuid(String userId,
                                                              String relationshipGuid)
                                                       throws MetadataServerUncontactableException,
                                                              UserNotAuthorizedException,
                                                              InvalidParameterException,
                                                              UnrecognizedGUIDException

Get TopicSubscribers relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: TopicSubscribers relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateTopicSubscribersRelationship

public TopicSubscribers updateTopicSubscribersRelationship(String userId,
                                                           TopicSubscribers topicSubscribers)
                                                    throws UserNotAuthorizedException,
                                                           MetadataServerUncontactableException,
                                                           InvalidParameterException,
                                                           StatusNotSupportedException,
                                                           UnrecognizedGUIDException

Update TopicSubscribers relationship

Parameters:: userId - user identity; topicSubscribers - relationship
Returns:: TopicSubscribers relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createReplacementTermRelationship

public ReplacementTerm createReplacementTermRelationship(String userId,
                                                         ReplacementTerm relationship)
                                                  throws MetadataServerUncontactableException,
                                                         UserNotAuthorizedException,
                                                         InvalidParameterException,
                                                         UnrecognizedGUIDException,
                                                         StatusNotSupportedException

Create ReplacementTerm relationship

Parameters:: userId - user identity; relationship - ReplacementTerm relationship to create
Returns:: created ReplacementTerm relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getReplacementTermRelationshipByGuid

public ReplacementTerm getReplacementTermRelationshipByGuid(String userId,
                                                            String relationshipGuid)
                                                     throws MetadataServerUncontactableException,
                                                            UserNotAuthorizedException,
                                                            InvalidParameterException,
                                                            UnrecognizedGUIDException

Get ReplacementTerm relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: ReplacementTerm relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateReplacementTermRelationship

public ReplacementTerm updateReplacementTermRelationship(String userId,
                                                         ReplacementTerm replacementTerm)
                                                  throws UserNotAuthorizedException,
                                                         MetadataServerUncontactableException,
                                                         InvalidParameterException,
                                                         StatusNotSupportedException,
                                                         UnrecognizedGUIDException

Update ReplacementTerm relationship

Parameters:: userId - user identity; replacementTerm - relationship
Returns:: ReplacementTerm relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createOrganizationalCapabilityRelationship

public OrganizationalCapability createOrganizationalCapabilityRelationship(String userId,
                                                                           OrganizationalCapability relationship)
                                                                    throws MetadataServerUncontactableException,
                                                                           UserNotAuthorizedException,
                                                                           InvalidParameterException,
                                                                           UnrecognizedGUIDException,
                                                                           StatusNotSupportedException

Create OrganizationalCapability relationship

Parameters:: userId - user identity; relationship - OrganizationalCapability relationship to create
Returns:: created OrganizationalCapability relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getOrganizationalCapabilityRelationshipByGuid

public OrganizationalCapability getOrganizationalCapabilityRelationshipByGuid(String userId,
                                                                              String relationshipGuid)
                                                                       throws MetadataServerUncontactableException,
                                                                              UserNotAuthorizedException,
                                                                              InvalidParameterException,
                                                                              UnrecognizedGUIDException

Get OrganizationalCapability relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: OrganizationalCapability relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateOrganizationalCapabilityRelationship

public OrganizationalCapability updateOrganizationalCapabilityRelationship(String userId,
                                                                           OrganizationalCapability organizationalCapability)
                                                                    throws UserNotAuthorizedException,
                                                                           MetadataServerUncontactableException,
                                                                           InvalidParameterException,
                                                                           StatusNotSupportedException,
                                                                           UnrecognizedGUIDException

Update OrganizationalCapability relationship

Parameters:: userId - user identity; organizationalCapability - relationship
Returns:: OrganizationalCapability relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createMetadataCohortPeerRelationship

public MetadataCohortPeer createMetadataCohortPeerRelationship(String userId,
                                                               MetadataCohortPeer relationship)
                                                        throws MetadataServerUncontactableException,
                                                               UserNotAuthorizedException,
                                                               InvalidParameterException,
                                                               UnrecognizedGUIDException,
                                                               StatusNotSupportedException

Create MetadataCohortPeer relationship

Parameters:: userId - user identity; relationship - MetadataCohortPeer relationship to create
Returns:: created MetadataCohortPeer relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getMetadataCohortPeerRelationshipByGuid

public MetadataCohortPeer getMetadataCohortPeerRelationshipByGuid(String userId,
                                                                  String relationshipGuid)
                                                           throws MetadataServerUncontactableException,
                                                                  UserNotAuthorizedException,
                                                                  InvalidParameterException,
                                                                  UnrecognizedGUIDException

Get MetadataCohortPeer relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: MetadataCohortPeer relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateMetadataCohortPeerRelationship

public MetadataCohortPeer updateMetadataCohortPeerRelationship(String userId,
                                                               MetadataCohortPeer metadataCohortPeer)
                                                        throws UserNotAuthorizedException,
                                                               MetadataServerUncontactableException,
                                                               InvalidParameterException,
                                                               StatusNotSupportedException,
                                                               UnrecognizedGUIDException

Update MetadataCohortPeer relationship

Parameters:: userId - user identity; metadataCohortPeer - relationship
Returns:: MetadataCohortPeer relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createAttachedNoteLogEntryRelationship

public AttachedNoteLogEntry createAttachedNoteLogEntryRelationship(String userId,
                                                                   AttachedNoteLogEntry relationship)
                                                            throws MetadataServerUncontactableException,
                                                                   UserNotAuthorizedException,
                                                                   InvalidParameterException,
                                                                   UnrecognizedGUIDException,
                                                                   StatusNotSupportedException

Create AttachedNoteLogEntry relationship

Parameters:: userId - user identity; relationship - AttachedNoteLogEntry relationship to create
Returns:: created AttachedNoteLogEntry relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getAttachedNoteLogEntryRelationshipByGuid

public AttachedNoteLogEntry getAttachedNoteLogEntryRelationshipByGuid(String userId,
                                                                      String relationshipGuid)
                                                               throws MetadataServerUncontactableException,
                                                                      UserNotAuthorizedException,
                                                                      InvalidParameterException,
                                                                      UnrecognizedGUIDException

Get AttachedNoteLogEntry relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: AttachedNoteLogEntry relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateAttachedNoteLogEntryRelationship

public AttachedNoteLogEntry updateAttachedNoteLogEntryRelationship(String userId,
                                                                   AttachedNoteLogEntry attachedNoteLogEntry)
                                                            throws UserNotAuthorizedException,
                                                                   MetadataServerUncontactableException,
                                                                   InvalidParameterException,
                                                                   StatusNotSupportedException,
                                                                   UnrecognizedGUIDException

Update AttachedNoteLogEntry relationship

Parameters:: userId - user identity; attachedNoteLogEntry - relationship
Returns:: AttachedNoteLogEntry relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createAssetServerUseRelationship

public AssetServerUse createAssetServerUseRelationship(String userId,
                                                       AssetServerUse relationship)
                                                throws MetadataServerUncontactableException,
                                                       UserNotAuthorizedException,
                                                       InvalidParameterException,
                                                       UnrecognizedGUIDException,
                                                       StatusNotSupportedException

Create AssetServerUse relationship

Parameters:: userId - user identity; relationship - AssetServerUse relationship to create
Returns:: created AssetServerUse relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getAssetServerUseRelationshipByGuid

public AssetServerUse getAssetServerUseRelationshipByGuid(String userId,
                                                          String relationshipGuid)
                                                   throws MetadataServerUncontactableException,
                                                          UserNotAuthorizedException,
                                                          InvalidParameterException,
                                                          UnrecognizedGUIDException

Get AssetServerUse relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: AssetServerUse relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateAssetServerUseRelationship

public AssetServerUse updateAssetServerUseRelationship(String userId,
                                                       AssetServerUse assetServerUse)
                                                throws UserNotAuthorizedException,
                                                       MetadataServerUncontactableException,
                                                       InvalidParameterException,
                                                       StatusNotSupportedException,
                                                       UnrecognizedGUIDException

Update AssetServerUse relationship

Parameters:: userId - user identity; assetServerUse - relationship
Returns:: AssetServerUse relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createRuntimeForProcessRelationship

public RuntimeForProcess createRuntimeForProcessRelationship(String userId,
                                                             RuntimeForProcess relationship)
                                                      throws MetadataServerUncontactableException,
                                                             UserNotAuthorizedException,
                                                             InvalidParameterException,
                                                             UnrecognizedGUIDException,
                                                             StatusNotSupportedException

Create RuntimeForProcess relationship

Parameters:: userId - user identity; relationship - RuntimeForProcess relationship to create
Returns:: created RuntimeForProcess relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getRuntimeForProcessRelationshipByGuid

public RuntimeForProcess getRuntimeForProcessRelationshipByGuid(String userId,
                                                                String relationshipGuid)
                                                         throws MetadataServerUncontactableException,
                                                                UserNotAuthorizedException,
                                                                InvalidParameterException,
                                                                UnrecognizedGUIDException

Get RuntimeForProcess relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: RuntimeForProcess relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateRuntimeForProcessRelationship

public RuntimeForProcess updateRuntimeForProcessRelationship(String userId,
                                                             RuntimeForProcess runtimeForProcess)
                                                      throws UserNotAuthorizedException,
                                                             MetadataServerUncontactableException,
                                                             InvalidParameterException,
                                                             StatusNotSupportedException,
                                                             UnrecognizedGUIDException

Update RuntimeForProcess relationship

Parameters:: userId - user identity; runtimeForProcess - relationship
Returns:: RuntimeForProcess relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createNestedLocationRelationship

public NestedLocation createNestedLocationRelationship(String userId,
                                                       NestedLocation relationship)
                                                throws MetadataServerUncontactableException,
                                                       UserNotAuthorizedException,
                                                       InvalidParameterException,
                                                       UnrecognizedGUIDException,
                                                       StatusNotSupportedException

Create NestedLocation relationship

Parameters:: userId - user identity; relationship - NestedLocation relationship to create
Returns:: created NestedLocation relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getNestedLocationRelationshipByGuid

public NestedLocation getNestedLocationRelationshipByGuid(String userId,
                                                          String relationshipGuid)
                                                   throws MetadataServerUncontactableException,
                                                          UserNotAuthorizedException,
                                                          InvalidParameterException,
                                                          UnrecognizedGUIDException

Get NestedLocation relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: NestedLocation relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateNestedLocationRelationship

public NestedLocation updateNestedLocationRelationship(String userId,
                                                       NestedLocation nestedLocation)
                                                throws UserNotAuthorizedException,
                                                       MetadataServerUncontactableException,
                                                       InvalidParameterException,
                                                       StatusNotSupportedException,
                                                       UnrecognizedGUIDException

Update NestedLocation relationship

Parameters:: userId - user identity; nestedLocation - relationship
Returns:: NestedLocation relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createLinkedFileRelationship

public LinkedFile createLinkedFileRelationship(String userId,
                                               LinkedFile relationship)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               InvalidParameterException,
                                               UnrecognizedGUIDException,
                                               StatusNotSupportedException

Create LinkedFile relationship

Parameters:: userId - user identity; relationship - LinkedFile relationship to create
Returns:: created LinkedFile relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getLinkedFileRelationshipByGuid

public LinkedFile getLinkedFileRelationshipByGuid(String userId,
                                                  String relationshipGuid)
                                           throws MetadataServerUncontactableException,
                                                  UserNotAuthorizedException,
                                                  InvalidParameterException,
                                                  UnrecognizedGUIDException

Get LinkedFile relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: LinkedFile relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateLinkedFileRelationship

public LinkedFile updateLinkedFileRelationship(String userId,
                                               LinkedFile linkedFile)
                                        throws UserNotAuthorizedException,
                                               MetadataServerUncontactableException,
                                               InvalidParameterException,
                                               StatusNotSupportedException,
                                               UnrecognizedGUIDException

Update LinkedFile relationship

Parameters:: userId - user identity; linkedFile - relationship
Returns:: LinkedFile relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createTermCategorizationRelationship

public TermCategorization createTermCategorizationRelationship(String userId,
                                                               TermCategorization relationship)
                                                        throws MetadataServerUncontactableException,
                                                               UserNotAuthorizedException,
                                                               InvalidParameterException,
                                                               UnrecognizedGUIDException,
                                                               StatusNotSupportedException

Create TermCategorization relationship

Parameters:: userId - user identity; relationship - TermCategorization relationship to create
Returns:: created TermCategorization relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getTermCategorizationRelationshipByGuid

public TermCategorization getTermCategorizationRelationshipByGuid(String userId,
                                                                  String relationshipGuid)
                                                           throws MetadataServerUncontactableException,
                                                                  UserNotAuthorizedException,
                                                                  InvalidParameterException,
                                                                  UnrecognizedGUIDException

Get TermCategorization relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: TermCategorization relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateTermCategorizationRelationship

public TermCategorization updateTermCategorizationRelationship(String userId,
                                                               TermCategorization termCategorization)
                                                        throws UserNotAuthorizedException,
                                                               MetadataServerUncontactableException,
                                                               InvalidParameterException,
                                                               StatusNotSupportedException,
                                                               UnrecognizedGUIDException

Update TermCategorization relationship

Parameters:: userId - user identity; termCategorization - relationship
Returns:: TermCategorization relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createAPIEndpointRelationship

public APIEndpoint createAPIEndpointRelationship(String userId,
                                                 APIEndpoint relationship)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 UnrecognizedGUIDException,
                                                 StatusNotSupportedException

Create APIEndpoint relationship

Parameters:: userId - user identity; relationship - APIEndpoint relationship to create
Returns:: created APIEndpoint relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getAPIEndpointRelationshipByGuid

public APIEndpoint getAPIEndpointRelationshipByGuid(String userId,
                                                    String relationshipGuid)
                                             throws MetadataServerUncontactableException,
                                                    UserNotAuthorizedException,
                                                    InvalidParameterException,
                                                    UnrecognizedGUIDException

Get APIEndpoint relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: APIEndpoint relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateAPIEndpointRelationship

public APIEndpoint updateAPIEndpointRelationship(String userId,
                                                 APIEndpoint aPIEndpoint)
                                          throws UserNotAuthorizedException,
                                                 MetadataServerUncontactableException,
                                                 InvalidParameterException,
                                                 StatusNotSupportedException,
                                                 UnrecognizedGUIDException

Update APIEndpoint relationship

Parameters:: userId - user identity; aPIEndpoint - relationship
Returns:: APIEndpoint relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createConnectionEndpointRelationship

public ConnectionEndpoint createConnectionEndpointRelationship(String userId,
                                                               ConnectionEndpoint relationship)
                                                        throws MetadataServerUncontactableException,
                                                               UserNotAuthorizedException,
                                                               InvalidParameterException,
                                                               UnrecognizedGUIDException,
                                                               StatusNotSupportedException

Create ConnectionEndpoint relationship

Parameters:: userId - user identity; relationship - ConnectionEndpoint relationship to create
Returns:: created ConnectionEndpoint relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getConnectionEndpointRelationshipByGuid

public ConnectionEndpoint getConnectionEndpointRelationshipByGuid(String userId,
                                                                  String relationshipGuid)
                                                           throws MetadataServerUncontactableException,
                                                                  UserNotAuthorizedException,
                                                                  InvalidParameterException,
                                                                  UnrecognizedGUIDException

Get ConnectionEndpoint relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: ConnectionEndpoint relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateConnectionEndpointRelationship

public ConnectionEndpoint updateConnectionEndpointRelationship(String userId,
                                                               ConnectionEndpoint connectionEndpoint)
                                                        throws UserNotAuthorizedException,
                                                               MetadataServerUncontactableException,
                                                               InvalidParameterException,
                                                               StatusNotSupportedException,
                                                               UnrecognizedGUIDException

Update ConnectionEndpoint relationship

Parameters:: userId - user identity; connectionEndpoint - relationship
Returns:: ConnectionEndpoint relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createCategoryAnchorRelationship

public CategoryAnchor createCategoryAnchorRelationship(String userId,
                                                       CategoryAnchor relationship)
                                                throws MetadataServerUncontactableException,
                                                       UserNotAuthorizedException,
                                                       InvalidParameterException,
                                                       UnrecognizedGUIDException,
                                                       StatusNotSupportedException

Create CategoryAnchor relationship

Parameters:: userId - user identity; relationship - CategoryAnchor relationship to create
Returns:: created CategoryAnchor relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getCategoryAnchorRelationshipByGuid

public CategoryAnchor getCategoryAnchorRelationshipByGuid(String userId,
                                                          String relationshipGuid)
                                                   throws MetadataServerUncontactableException,
                                                          UserNotAuthorizedException,
                                                          InvalidParameterException,
                                                          UnrecognizedGUIDException

Get CategoryAnchor relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: CategoryAnchor relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateCategoryAnchorRelationship

public CategoryAnchor updateCategoryAnchorRelationship(String userId,
                                                       CategoryAnchor categoryAnchor)
                                                throws UserNotAuthorizedException,
                                                       MetadataServerUncontactableException,
                                                       InvalidParameterException,
                                                       StatusNotSupportedException,
                                                       UnrecognizedGUIDException

Update CategoryAnchor relationship

Parameters:: userId - user identity; categoryAnchor - relationship
Returns:: CategoryAnchor relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createProjectTeamRelationship

public ProjectTeam createProjectTeamRelationship(String userId,
                                                 ProjectTeam relationship)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 UnrecognizedGUIDException,
                                                 StatusNotSupportedException

Create ProjectTeam relationship

Parameters:: userId - user identity; relationship - ProjectTeam relationship to create
Returns:: created ProjectTeam relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getProjectTeamRelationshipByGuid

public ProjectTeam getProjectTeamRelationshipByGuid(String userId,
                                                    String relationshipGuid)
                                             throws MetadataServerUncontactableException,
                                                    UserNotAuthorizedException,
                                                    InvalidParameterException,
                                                    UnrecognizedGUIDException

Get ProjectTeam relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: ProjectTeam relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateProjectTeamRelationship

public ProjectTeam updateProjectTeamRelationship(String userId,
                                                 ProjectTeam projectTeam)
                                          throws UserNotAuthorizedException,
                                                 MetadataServerUncontactableException,
                                                 InvalidParameterException,
                                                 StatusNotSupportedException,
                                                 UnrecognizedGUIDException

Update ProjectTeam relationship

Parameters:: userId - user identity; projectTeam - relationship
Returns:: ProjectTeam relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createProcessOutputRelationship

public ProcessOutput createProcessOutputRelationship(String userId,
                                                     ProcessOutput relationship)
                                              throws MetadataServerUncontactableException,
                                                     UserNotAuthorizedException,
                                                     InvalidParameterException,
                                                     UnrecognizedGUIDException,
                                                     StatusNotSupportedException

Create ProcessOutput relationship

Parameters:: userId - user identity; relationship - ProcessOutput relationship to create
Returns:: created ProcessOutput relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getProcessOutputRelationshipByGuid

public ProcessOutput getProcessOutputRelationshipByGuid(String userId,
                                                        String relationshipGuid)
                                                 throws MetadataServerUncontactableException,
                                                        UserNotAuthorizedException,
                                                        InvalidParameterException,
                                                        UnrecognizedGUIDException

Get ProcessOutput relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: ProcessOutput relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateProcessOutputRelationship

public ProcessOutput updateProcessOutputRelationship(String userId,
                                                     ProcessOutput processOutput)
                                              throws UserNotAuthorizedException,
                                                     MetadataServerUncontactableException,
                                                     InvalidParameterException,
                                                     StatusNotSupportedException,
                                                     UnrecognizedGUIDException

Update ProcessOutput relationship

Parameters:: userId - user identity; processOutput - relationship
Returns:: ProcessOutput relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createAPIOperationsRelationship

public APIOperations createAPIOperationsRelationship(String userId,
                                                     APIOperations relationship)
                                              throws MetadataServerUncontactableException,
                                                     UserNotAuthorizedException,
                                                     InvalidParameterException,
                                                     UnrecognizedGUIDException,
                                                     StatusNotSupportedException

Create APIOperations relationship

Parameters:: userId - user identity; relationship - APIOperations relationship to create
Returns:: created APIOperations relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getAPIOperationsRelationshipByGuid

public APIOperations getAPIOperationsRelationshipByGuid(String userId,
                                                        String relationshipGuid)
                                                 throws MetadataServerUncontactableException,
                                                        UserNotAuthorizedException,
                                                        InvalidParameterException,
                                                        UnrecognizedGUIDException

Get APIOperations relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: APIOperations relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateAPIOperationsRelationship

public APIOperations updateAPIOperationsRelationship(String userId,
                                                     APIOperations aPIOperations)
                                              throws UserNotAuthorizedException,
                                                     MetadataServerUncontactableException,
                                                     InvalidParameterException,
                                                     StatusNotSupportedException,
                                                     UnrecognizedGUIDException

Update APIOperations relationship

Parameters:: userId - user identity; aPIOperations - relationship
Returns:: APIOperations relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createGovernancePolicyLinkRelationship

public GovernancePolicyLink createGovernancePolicyLinkRelationship(String userId,
                                                                   GovernancePolicyLink relationship)
                                                            throws MetadataServerUncontactableException,
                                                                   UserNotAuthorizedException,
                                                                   InvalidParameterException,
                                                                   UnrecognizedGUIDException,
                                                                   StatusNotSupportedException

Create GovernancePolicyLink relationship

Parameters:: userId - user identity; relationship - GovernancePolicyLink relationship to create
Returns:: created GovernancePolicyLink relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getGovernancePolicyLinkRelationshipByGuid

public GovernancePolicyLink getGovernancePolicyLinkRelationshipByGuid(String userId,
                                                                      String relationshipGuid)
                                                               throws MetadataServerUncontactableException,
                                                                      UserNotAuthorizedException,
                                                                      InvalidParameterException,
                                                                      UnrecognizedGUIDException

Get GovernancePolicyLink relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: GovernancePolicyLink relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateGovernancePolicyLinkRelationship

public GovernancePolicyLink updateGovernancePolicyLinkRelationship(String userId,
                                                                   GovernancePolicyLink governancePolicyLink)
                                                            throws UserNotAuthorizedException,
                                                                   MetadataServerUncontactableException,
                                                                   InvalidParameterException,
                                                                   StatusNotSupportedException,
                                                                   UnrecognizedGUIDException

Update GovernancePolicyLink relationship

Parameters:: userId - user identity; governancePolicyLink - relationship
Returns:: GovernancePolicyLink relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createResponsibilityStaffContactRelationship

public ResponsibilityStaffContact createResponsibilityStaffContactRelationship(String userId,
                                                                               ResponsibilityStaffContact relationship)
                                                                        throws MetadataServerUncontactableException,
                                                                               UserNotAuthorizedException,
                                                                               InvalidParameterException,
                                                                               UnrecognizedGUIDException,
                                                                               StatusNotSupportedException

Create ResponsibilityStaffContact relationship

Parameters:: userId - user identity; relationship - ResponsibilityStaffContact relationship to create
Returns:: created ResponsibilityStaffContact relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getResponsibilityStaffContactRelationshipByGuid

public ResponsibilityStaffContact getResponsibilityStaffContactRelationshipByGuid(String userId,
                                                                                  String relationshipGuid)
                                                                           throws MetadataServerUncontactableException,
                                                                                  UserNotAuthorizedException,
                                                                                  InvalidParameterException,
                                                                                  UnrecognizedGUIDException

Get ResponsibilityStaffContact relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: ResponsibilityStaffContact relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateResponsibilityStaffContactRelationship

public ResponsibilityStaffContact updateResponsibilityStaffContactRelationship(String userId,
                                                                               ResponsibilityStaffContact responsibilityStaffContact)
                                                                        throws UserNotAuthorizedException,
                                                                               MetadataServerUncontactableException,
                                                                               InvalidParameterException,
                                                                               StatusNotSupportedException,
                                                                               UnrecognizedGUIDException

Update ResponsibilityStaffContact relationship

Parameters:: userId - user identity; responsibilityStaffContact - relationship
Returns:: ResponsibilityStaffContact relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createPeerRelationship
```
public Peer createPeerRelationship(String userId,
                                   Peer relationship)
                            throws MetadataServerUncontactableException,
                                   UserNotAuthorizedException,
                                   InvalidParameterException,
                                   UnrecognizedGUIDException,
                                   StatusNotSupportedException
```
Create Peer relationship

Parameters:

userId - user identity

relationship - Peer relationship to create

Returns:

created Peer relationship

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

StatusNotSupportedException - status is not supported

getPeerRelationshipByGuid
```
public Peer getPeerRelationshipByGuid(String userId,
                                      String relationshipGuid)
                               throws MetadataServerUncontactableException,
                                      UserNotAuthorizedException,
                                      InvalidParameterException,
                                      UnrecognizedGUIDException
```
Get Peer relationship

Parameters:

userId - user identity

relationshipGuid - relationship guid

Returns:

Peer relationship

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updatePeerRelationship

public Peer updatePeerRelationship(String userId,
                                   Peer peer)
                            throws UserNotAuthorizedException,
                                   MetadataServerUncontactableException,
                                   InvalidParameterException,
                                   StatusNotSupportedException,
                                   UnrecognizedGUIDException

Update Peer relationship

Parameters:: userId - user identity; peer - relationship
Returns:: Peer relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createTermTYPEDBYRelationshipRelationship

public TermTYPEDBYRelationship createTermTYPEDBYRelationshipRelationship(String userId,
                                                                         TermTYPEDBYRelationship relationship)
                                                                  throws MetadataServerUncontactableException,
                                                                         UserNotAuthorizedException,
                                                                         InvalidParameterException,
                                                                         UnrecognizedGUIDException,
                                                                         StatusNotSupportedException

Create TermTYPEDBYRelationship relationship

Parameters:: userId - user identity; relationship - TermTYPEDBYRelationship relationship to create
Returns:: created TermTYPEDBYRelationship relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getTermTYPEDBYRelationshipRelationshipByGuid

public TermTYPEDBYRelationship getTermTYPEDBYRelationshipRelationshipByGuid(String userId,
                                                                            String relationshipGuid)
                                                                     throws MetadataServerUncontactableException,
                                                                            UserNotAuthorizedException,
                                                                            InvalidParameterException,
                                                                            UnrecognizedGUIDException

Get TermTYPEDBYRelationship relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: TermTYPEDBYRelationship relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateTermTYPEDBYRelationshipRelationship

public TermTYPEDBYRelationship updateTermTYPEDBYRelationshipRelationship(String userId,
                                                                         TermTYPEDBYRelationship termTYPEDBYRelationship)
                                                                  throws UserNotAuthorizedException,
                                                                         MetadataServerUncontactableException,
                                                                         InvalidParameterException,
                                                                         StatusNotSupportedException,
                                                                         UnrecognizedGUIDException

Update TermTYPEDBYRelationship relationship

Parameters:: userId - user identity; termTYPEDBYRelationship - relationship
Returns:: TermTYPEDBYRelationship relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createMapFromElementTypeRelationship

public MapFromElementType createMapFromElementTypeRelationship(String userId,
                                                               MapFromElementType relationship)
                                                        throws MetadataServerUncontactableException,
                                                               UserNotAuthorizedException,
                                                               InvalidParameterException,
                                                               UnrecognizedGUIDException,
                                                               StatusNotSupportedException

Create MapFromElementType relationship

Parameters:: userId - user identity; relationship - MapFromElementType relationship to create
Returns:: created MapFromElementType relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getMapFromElementTypeRelationshipByGuid

public MapFromElementType getMapFromElementTypeRelationshipByGuid(String userId,
                                                                  String relationshipGuid)
                                                           throws MetadataServerUncontactableException,
                                                                  UserNotAuthorizedException,
                                                                  InvalidParameterException,
                                                                  UnrecognizedGUIDException

Get MapFromElementType relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: MapFromElementType relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateMapFromElementTypeRelationship

public MapFromElementType updateMapFromElementTypeRelationship(String userId,
                                                               MapFromElementType mapFromElementType)
                                                        throws UserNotAuthorizedException,
                                                               MetadataServerUncontactableException,
                                                               InvalidParameterException,
                                                               StatusNotSupportedException,
                                                               UnrecognizedGUIDException

Update MapFromElementType relationship

Parameters:: userId - user identity; mapFromElementType - relationship
Returns:: MapFromElementType relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createCertificationRelationship

public Certification createCertificationRelationship(String userId,
                                                     Certification relationship)
                                              throws MetadataServerUncontactableException,
                                                     UserNotAuthorizedException,
                                                     InvalidParameterException,
                                                     UnrecognizedGUIDException,
                                                     StatusNotSupportedException

Create Certification relationship

Parameters:: userId - user identity; relationship - Certification relationship to create
Returns:: created Certification relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getCertificationRelationshipByGuid

public Certification getCertificationRelationshipByGuid(String userId,
                                                        String relationshipGuid)
                                                 throws MetadataServerUncontactableException,
                                                        UserNotAuthorizedException,
                                                        InvalidParameterException,
                                                        UnrecognizedGUIDException

Get Certification relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: Certification relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateCertificationRelationship

public Certification updateCertificationRelationship(String userId,
                                                     Certification certification)
                                              throws UserNotAuthorizedException,
                                                     MetadataServerUncontactableException,
                                                     InvalidParameterException,
                                                     StatusNotSupportedException,
                                                     UnrecognizedGUIDException

Update Certification relationship

Parameters:: userId - user identity; certification - relationship
Returns:: Certification relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createNetworkGatewayLinkRelationship

public NetworkGatewayLink createNetworkGatewayLinkRelationship(String userId,
                                                               NetworkGatewayLink relationship)
                                                        throws MetadataServerUncontactableException,
                                                               UserNotAuthorizedException,
                                                               InvalidParameterException,
                                                               UnrecognizedGUIDException,
                                                               StatusNotSupportedException

Create NetworkGatewayLink relationship

Parameters:: userId - user identity; relationship - NetworkGatewayLink relationship to create
Returns:: created NetworkGatewayLink relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getNetworkGatewayLinkRelationshipByGuid

public NetworkGatewayLink getNetworkGatewayLinkRelationshipByGuid(String userId,
                                                                  String relationshipGuid)
                                                           throws MetadataServerUncontactableException,
                                                                  UserNotAuthorizedException,
                                                                  InvalidParameterException,
                                                                  UnrecognizedGUIDException

Get NetworkGatewayLink relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: NetworkGatewayLink relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateNetworkGatewayLinkRelationship

public NetworkGatewayLink updateNetworkGatewayLinkRelationship(String userId,
                                                               NetworkGatewayLink networkGatewayLink)
                                                        throws UserNotAuthorizedException,
                                                               MetadataServerUncontactableException,
                                                               InvalidParameterException,
                                                               StatusNotSupportedException,
                                                               UnrecognizedGUIDException

Update NetworkGatewayLink relationship

Parameters:: userId - user identity; networkGatewayLink - relationship
Returns:: NetworkGatewayLink relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createConnectionConnectorTypeRelationship

public ConnectionConnectorType createConnectionConnectorTypeRelationship(String userId,
                                                                         ConnectionConnectorType relationship)
                                                                  throws MetadataServerUncontactableException,
                                                                         UserNotAuthorizedException,
                                                                         InvalidParameterException,
                                                                         UnrecognizedGUIDException,
                                                                         StatusNotSupportedException

Create ConnectionConnectorType relationship

Parameters:: userId - user identity; relationship - ConnectionConnectorType relationship to create
Returns:: created ConnectionConnectorType relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getConnectionConnectorTypeRelationshipByGuid

public ConnectionConnectorType getConnectionConnectorTypeRelationshipByGuid(String userId,
                                                                            String relationshipGuid)
                                                                     throws MetadataServerUncontactableException,
                                                                            UserNotAuthorizedException,
                                                                            InvalidParameterException,
                                                                            UnrecognizedGUIDException

Get ConnectionConnectorType relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: ConnectionConnectorType relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateConnectionConnectorTypeRelationship

public ConnectionConnectorType updateConnectionConnectorTypeRelationship(String userId,
                                                                         ConnectionConnectorType connectionConnectorType)
                                                                  throws UserNotAuthorizedException,
                                                                         MetadataServerUncontactableException,
                                                                         InvalidParameterException,
                                                                         StatusNotSupportedException,
                                                                         UnrecognizedGUIDException

Update ConnectionConnectorType relationship

Parameters:: userId - user identity; connectionConnectorType - relationship
Returns:: ConnectionConnectorType relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createSynonymRelationship

public Synonym createSynonymRelationship(String userId,
                                         Synonym relationship)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         InvalidParameterException,
                                         UnrecognizedGUIDException,
                                         StatusNotSupportedException

Create Synonym relationship

Parameters:: userId - user identity; relationship - Synonym relationship to create
Returns:: created Synonym relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getSynonymRelationshipByGuid

public Synonym getSynonymRelationshipByGuid(String userId,
                                            String relationshipGuid)
                                     throws MetadataServerUncontactableException,
                                            UserNotAuthorizedException,
                                            InvalidParameterException,
                                            UnrecognizedGUIDException

Get Synonym relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: Synonym relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateSynonymRelationship

public Synonym updateSynonymRelationship(String userId,
                                         Synonym synonym)
                                  throws UserNotAuthorizedException,
                                         MetadataServerUncontactableException,
                                         InvalidParameterException,
                                         StatusNotSupportedException,
                                         UnrecognizedGUIDException

Update Synonym relationship

Parameters:: userId - user identity; synonym - relationship
Returns:: Synonym relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createAntonymRelationship

public Antonym createAntonymRelationship(String userId,
                                         Antonym relationship)
                                  throws MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         InvalidParameterException,
                                         UnrecognizedGUIDException,
                                         StatusNotSupportedException

Create Antonym relationship

Parameters:: userId - user identity; relationship - Antonym relationship to create
Returns:: created Antonym relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getAntonymRelationshipByGuid

public Antonym getAntonymRelationshipByGuid(String userId,
                                            String relationshipGuid)
                                     throws MetadataServerUncontactableException,
                                            UserNotAuthorizedException,
                                            InvalidParameterException,
                                            UnrecognizedGUIDException

Get Antonym relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: Antonym relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateAntonymRelationship

public Antonym updateAntonymRelationship(String userId,
                                         Antonym antonym)
                                  throws UserNotAuthorizedException,
                                         MetadataServerUncontactableException,
                                         InvalidParameterException,
                                         StatusNotSupportedException,
                                         UnrecognizedGUIDException

Update Antonym relationship

Parameters:: userId - user identity; antonym - relationship
Returns:: Antonym relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createGraphEdgeLinkRelationship

public GraphEdgeLink createGraphEdgeLinkRelationship(String userId,
                                                     GraphEdgeLink relationship)
                                              throws MetadataServerUncontactableException,
                                                     UserNotAuthorizedException,
                                                     InvalidParameterException,
                                                     UnrecognizedGUIDException,
                                                     StatusNotSupportedException

Create GraphEdgeLink relationship

Parameters:: userId - user identity; relationship - GraphEdgeLink relationship to create
Returns:: created GraphEdgeLink relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getGraphEdgeLinkRelationshipByGuid

public GraphEdgeLink getGraphEdgeLinkRelationshipByGuid(String userId,
                                                        String relationshipGuid)
                                                 throws MetadataServerUncontactableException,
                                                        UserNotAuthorizedException,
                                                        InvalidParameterException,
                                                        UnrecognizedGUIDException

Get GraphEdgeLink relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: GraphEdgeLink relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateGraphEdgeLinkRelationship

public GraphEdgeLink updateGraphEdgeLinkRelationship(String userId,
                                                     GraphEdgeLink graphEdgeLink)
                                              throws UserNotAuthorizedException,
                                                     MetadataServerUncontactableException,
                                                     InvalidParameterException,
                                                     StatusNotSupportedException,
                                                     UnrecognizedGUIDException

Update GraphEdgeLink relationship

Parameters:: userId - user identity; graphEdgeLink - relationship
Returns:: GraphEdgeLink relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createProjectScopeRelationship

public ProjectScope createProjectScopeRelationship(String userId,
                                                   ProjectScope relationship)
                                            throws MetadataServerUncontactableException,
                                                   UserNotAuthorizedException,
                                                   InvalidParameterException,
                                                   UnrecognizedGUIDException,
                                                   StatusNotSupportedException

Create ProjectScope relationship

Parameters:: userId - user identity; relationship - ProjectScope relationship to create
Returns:: created ProjectScope relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getProjectScopeRelationshipByGuid

public ProjectScope getProjectScopeRelationshipByGuid(String userId,
                                                      String relationshipGuid)
                                               throws MetadataServerUncontactableException,
                                                      UserNotAuthorizedException,
                                                      InvalidParameterException,
                                                      UnrecognizedGUIDException

Get ProjectScope relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: ProjectScope relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateProjectScopeRelationship

public ProjectScope updateProjectScopeRelationship(String userId,
                                                   ProjectScope projectScope)
                                            throws UserNotAuthorizedException,
                                                   MetadataServerUncontactableException,
                                                   InvalidParameterException,
                                                   StatusNotSupportedException,
                                                   UnrecognizedGUIDException

Update ProjectScope relationship

Parameters:: userId - user identity; projectScope - relationship
Returns:: ProjectScope relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createISARelationshipRelationship

public ISARelationship createISARelationshipRelationship(String userId,
                                                         ISARelationship relationship)
                                                  throws MetadataServerUncontactableException,
                                                         UserNotAuthorizedException,
                                                         InvalidParameterException,
                                                         UnrecognizedGUIDException,
                                                         StatusNotSupportedException

Create ISARelationship relationship

Parameters:: userId - user identity; relationship - ISARelationship relationship to create
Returns:: created ISARelationship relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getISARelationshipRelationshipByGuid

public ISARelationship getISARelationshipRelationshipByGuid(String userId,
                                                            String relationshipGuid)
                                                     throws MetadataServerUncontactableException,
                                                            UserNotAuthorizedException,
                                                            InvalidParameterException,
                                                            UnrecognizedGUIDException

Get ISARelationship relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: ISARelationship relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateISARelationshipRelationship

public ISARelationship updateISARelationshipRelationship(String userId,
                                                         ISARelationship iSARelationship)
                                                  throws UserNotAuthorizedException,
                                                         MetadataServerUncontactableException,
                                                         InvalidParameterException,
                                                         StatusNotSupportedException,
                                                         UnrecognizedGUIDException

Update ISARelationship relationship

Parameters:: userId - user identity; iSARelationship - relationship
Returns:: ISARelationship relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createTermISATypeOFRelationshipRelationship

public TermISATypeOFRelationship createTermISATypeOFRelationshipRelationship(String userId,
                                                                             TermISATypeOFRelationship relationship)
                                                                      throws MetadataServerUncontactableException,
                                                                             UserNotAuthorizedException,
                                                                             InvalidParameterException,
                                                                             UnrecognizedGUIDException,
                                                                             StatusNotSupportedException

Create TermISATypeOFRelationship relationship

Parameters:: userId - user identity; relationship - TermISATypeOFRelationship relationship to create
Returns:: created TermISATypeOFRelationship relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getTermISATypeOFRelationshipRelationshipByGuid

public TermISATypeOFRelationship getTermISATypeOFRelationshipRelationshipByGuid(String userId,
                                                                                String relationshipGuid)
                                                                         throws MetadataServerUncontactableException,
                                                                                UserNotAuthorizedException,
                                                                                InvalidParameterException,
                                                                                UnrecognizedGUIDException

Get TermISATypeOFRelationship relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: TermISATypeOFRelationship relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateTermISATypeOFRelationshipRelationship

public TermISATypeOFRelationship updateTermISATypeOFRelationshipRelationship(String userId,
                                                                             TermISATypeOFRelationship termISATypeOFRelationship)
                                                                      throws UserNotAuthorizedException,
                                                                             MetadataServerUncontactableException,
                                                                             InvalidParameterException,
                                                                             StatusNotSupportedException,
                                                                             UnrecognizedGUIDException

Update TermISATypeOFRelationship relationship

Parameters:: userId - user identity; termISATypeOFRelationship - relationship
Returns:: TermISATypeOFRelationship relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createEmbeddedConnectionRelationship

public EmbeddedConnection createEmbeddedConnectionRelationship(String userId,
                                                               EmbeddedConnection relationship)
                                                        throws MetadataServerUncontactableException,
                                                               UserNotAuthorizedException,
                                                               InvalidParameterException,
                                                               UnrecognizedGUIDException,
                                                               StatusNotSupportedException

Create EmbeddedConnection relationship

Parameters:: userId - user identity; relationship - EmbeddedConnection relationship to create
Returns:: created EmbeddedConnection relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getEmbeddedConnectionRelationshipByGuid

public EmbeddedConnection getEmbeddedConnectionRelationshipByGuid(String userId,
                                                                  String relationshipGuid)
                                                           throws MetadataServerUncontactableException,
                                                                  UserNotAuthorizedException,
                                                                  InvalidParameterException,
                                                                  UnrecognizedGUIDException

Get EmbeddedConnection relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: EmbeddedConnection relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateEmbeddedConnectionRelationship

public EmbeddedConnection updateEmbeddedConnectionRelationship(String userId,
                                                               EmbeddedConnection embeddedConnection)
                                                        throws UserNotAuthorizedException,
                                                               MetadataServerUncontactableException,
                                                               InvalidParameterException,
                                                               StatusNotSupportedException,
                                                               UnrecognizedGUIDException

Update EmbeddedConnection relationship

Parameters:: userId - user identity; embeddedConnection - relationship
Returns:: EmbeddedConnection relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createGovernanceControlLinkRelationship

public GovernanceControlLink createGovernanceControlLinkRelationship(String userId,
                                                                     GovernanceControlLink relationship)
                                                              throws MetadataServerUncontactableException,
                                                                     UserNotAuthorizedException,
                                                                     InvalidParameterException,
                                                                     UnrecognizedGUIDException,
                                                                     StatusNotSupportedException

Create GovernanceControlLink relationship

Parameters:: userId - user identity; relationship - GovernanceControlLink relationship to create
Returns:: created GovernanceControlLink relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getGovernanceControlLinkRelationshipByGuid

public GovernanceControlLink getGovernanceControlLinkRelationshipByGuid(String userId,
                                                                        String relationshipGuid)
                                                                 throws MetadataServerUncontactableException,
                                                                        UserNotAuthorizedException,
                                                                        InvalidParameterException,
                                                                        UnrecognizedGUIDException

Get GovernanceControlLink relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: GovernanceControlLink relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateGovernanceControlLinkRelationship

public GovernanceControlLink updateGovernanceControlLinkRelationship(String userId,
                                                                     GovernanceControlLink governanceControlLink)
                                                              throws UserNotAuthorizedException,
                                                                     MetadataServerUncontactableException,
                                                                     InvalidParameterException,
                                                                     StatusNotSupportedException,
                                                                     UnrecognizedGUIDException

Update GovernanceControlLink relationship

Parameters:: userId - user identity; governanceControlLink - relationship
Returns:: GovernanceControlLink relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createAttachedRatingRelationship

public AttachedRating createAttachedRatingRelationship(String userId,
                                                       AttachedRating relationship)
                                                throws MetadataServerUncontactableException,
                                                       UserNotAuthorizedException,
                                                       InvalidParameterException,
                                                       UnrecognizedGUIDException,
                                                       StatusNotSupportedException

Create AttachedRating relationship

Parameters:: userId - user identity; relationship - AttachedRating relationship to create
Returns:: created AttachedRating relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getAttachedRatingRelationshipByGuid

public AttachedRating getAttachedRatingRelationshipByGuid(String userId,
                                                          String relationshipGuid)
                                                   throws MetadataServerUncontactableException,
                                                          UserNotAuthorizedException,
                                                          InvalidParameterException,
                                                          UnrecognizedGUIDException

Get AttachedRating relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: AttachedRating relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateAttachedRatingRelationship

public AttachedRating updateAttachedRatingRelationship(String userId,
                                                       AttachedRating attachedRating)
                                                throws UserNotAuthorizedException,
                                                       MetadataServerUncontactableException,
                                                       InvalidParameterException,
                                                       StatusNotSupportedException,
                                                       UnrecognizedGUIDException

Update AttachedRating relationship

Parameters:: userId - user identity; attachedRating - relationship
Returns:: AttachedRating relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createAttachedNoteLogRelationship

public AttachedNoteLog createAttachedNoteLogRelationship(String userId,
                                                         AttachedNoteLog relationship)
                                                  throws MetadataServerUncontactableException,
                                                         UserNotAuthorizedException,
                                                         InvalidParameterException,
                                                         UnrecognizedGUIDException,
                                                         StatusNotSupportedException

Create AttachedNoteLog relationship

Parameters:: userId - user identity; relationship - AttachedNoteLog relationship to create
Returns:: created AttachedNoteLog relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getAttachedNoteLogRelationshipByGuid

public AttachedNoteLog getAttachedNoteLogRelationshipByGuid(String userId,
                                                            String relationshipGuid)
                                                     throws MetadataServerUncontactableException,
                                                            UserNotAuthorizedException,
                                                            InvalidParameterException,
                                                            UnrecognizedGUIDException

Get AttachedNoteLog relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: AttachedNoteLog relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateAttachedNoteLogRelationship

public AttachedNoteLog updateAttachedNoteLogRelationship(String userId,
                                                         AttachedNoteLog attachedNoteLog)
                                                  throws UserNotAuthorizedException,
                                                         MetadataServerUncontactableException,
                                                         InvalidParameterException,
                                                         StatusNotSupportedException,
                                                         UnrecognizedGUIDException

Update AttachedNoteLog relationship

Parameters:: userId - user identity; attachedNoteLog - relationship
Returns:: AttachedNoteLog relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createConnectionToAssetRelationship

public ConnectionToAsset createConnectionToAssetRelationship(String userId,
                                                             ConnectionToAsset relationship)
                                                      throws MetadataServerUncontactableException,
                                                             UserNotAuthorizedException,
                                                             InvalidParameterException,
                                                             UnrecognizedGUIDException,
                                                             StatusNotSupportedException

Create ConnectionToAsset relationship

Parameters:: userId - user identity; relationship - ConnectionToAsset relationship to create
Returns:: created ConnectionToAsset relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getConnectionToAssetRelationshipByGuid

public ConnectionToAsset getConnectionToAssetRelationshipByGuid(String userId,
                                                                String relationshipGuid)
                                                         throws MetadataServerUncontactableException,
                                                                UserNotAuthorizedException,
                                                                InvalidParameterException,
                                                                UnrecognizedGUIDException

Get ConnectionToAsset relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: ConnectionToAsset relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateConnectionToAssetRelationship

public ConnectionToAsset updateConnectionToAssetRelationship(String userId,
                                                             ConnectionToAsset connectionToAsset)
                                                      throws UserNotAuthorizedException,
                                                             MetadataServerUncontactableException,
                                                             InvalidParameterException,
                                                             StatusNotSupportedException,
                                                             UnrecognizedGUIDException

Update ConnectionToAsset relationship

Parameters:: userId - user identity; connectionToAsset - relationship
Returns:: ConnectionToAsset relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createRegulationCertificationTypeRelationship

public RegulationCertificationType createRegulationCertificationTypeRelationship(String userId,
                                                                                 RegulationCertificationType relationship)
                                                                          throws MetadataServerUncontactableException,
                                                                                 UserNotAuthorizedException,
                                                                                 InvalidParameterException,
                                                                                 UnrecognizedGUIDException,
                                                                                 StatusNotSupportedException

Create RegulationCertificationType relationship

Parameters:: userId - user identity; relationship - RegulationCertificationType relationship to create
Returns:: created RegulationCertificationType relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getRegulationCertificationTypeRelationshipByGuid

public RegulationCertificationType getRegulationCertificationTypeRelationshipByGuid(String userId,
                                                                                    String relationshipGuid)
                                                                             throws MetadataServerUncontactableException,
                                                                                    UserNotAuthorizedException,
                                                                                    InvalidParameterException,
                                                                                    UnrecognizedGUIDException

Get RegulationCertificationType relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: RegulationCertificationType relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateRegulationCertificationTypeRelationship

public RegulationCertificationType updateRegulationCertificationTypeRelationship(String userId,
                                                                                 RegulationCertificationType regulationCertificationType)
                                                                          throws UserNotAuthorizedException,
                                                                                 MetadataServerUncontactableException,
                                                                                 InvalidParameterException,
                                                                                 StatusNotSupportedException,
                                                                                 UnrecognizedGUIDException

Update RegulationCertificationType relationship

Parameters:: userId - user identity; regulationCertificationType - relationship
Returns:: RegulationCertificationType relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createLinkedTypeRelationship

public LinkedType createLinkedTypeRelationship(String userId,
                                               LinkedType relationship)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               InvalidParameterException,
                                               UnrecognizedGUIDException,
                                               StatusNotSupportedException

Create LinkedType relationship

Parameters:: userId - user identity; relationship - LinkedType relationship to create
Returns:: created LinkedType relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getLinkedTypeRelationshipByGuid

public LinkedType getLinkedTypeRelationshipByGuid(String userId,
                                                  String relationshipGuid)
                                           throws MetadataServerUncontactableException,
                                                  UserNotAuthorizedException,
                                                  InvalidParameterException,
                                                  UnrecognizedGUIDException

Get LinkedType relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: LinkedType relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateLinkedTypeRelationship

public LinkedType updateLinkedTypeRelationship(String userId,
                                               LinkedType linkedType)
                                        throws UserNotAuthorizedException,
                                               MetadataServerUncontactableException,
                                               InvalidParameterException,
                                               StatusNotSupportedException,
                                               UnrecognizedGUIDException

Update LinkedType relationship

Parameters:: userId - user identity; linkedType - relationship
Returns:: LinkedType relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createGovernanceRuleImplementationRelationship

public GovernanceRuleImplementation createGovernanceRuleImplementationRelationship(String userId,
                                                                                   GovernanceRuleImplementation relationship)
                                                                            throws MetadataServerUncontactableException,
                                                                                   UserNotAuthorizedException,
                                                                                   InvalidParameterException,
                                                                                   UnrecognizedGUIDException,
                                                                                   StatusNotSupportedException

Create GovernanceRuleImplementation relationship

Parameters:: userId - user identity; relationship - GovernanceRuleImplementation relationship to create
Returns:: created GovernanceRuleImplementation relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getGovernanceRuleImplementationRelationshipByGuid

public GovernanceRuleImplementation getGovernanceRuleImplementationRelationshipByGuid(String userId,
                                                                                      String relationshipGuid)
                                                                               throws MetadataServerUncontactableException,
                                                                                      UserNotAuthorizedException,
                                                                                      InvalidParameterException,
                                                                                      UnrecognizedGUIDException

Get GovernanceRuleImplementation relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: GovernanceRuleImplementation relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateGovernanceRuleImplementationRelationship

public GovernanceRuleImplementation updateGovernanceRuleImplementationRelationship(String userId,
                                                                                   GovernanceRuleImplementation governanceRuleImplementation)
                                                                            throws UserNotAuthorizedException,
                                                                                   MetadataServerUncontactableException,
                                                                                   InvalidParameterException,
                                                                                   StatusNotSupportedException,
                                                                                   UnrecognizedGUIDException

Update GovernanceRuleImplementation relationship

Parameters:: userId - user identity; governanceRuleImplementation - relationship
Returns:: GovernanceRuleImplementation relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createAdjacentLocationRelationship

public AdjacentLocation createAdjacentLocationRelationship(String userId,
                                                           AdjacentLocation relationship)
                                                    throws MetadataServerUncontactableException,
                                                           UserNotAuthorizedException,
                                                           InvalidParameterException,
                                                           UnrecognizedGUIDException,
                                                           StatusNotSupportedException

Create AdjacentLocation relationship

Parameters:: userId - user identity; relationship - AdjacentLocation relationship to create
Returns:: created AdjacentLocation relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getAdjacentLocationRelationshipByGuid

public AdjacentLocation getAdjacentLocationRelationshipByGuid(String userId,
                                                              String relationshipGuid)
                                                       throws MetadataServerUncontactableException,
                                                              UserNotAuthorizedException,
                                                              InvalidParameterException,
                                                              UnrecognizedGUIDException

Get AdjacentLocation relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: AdjacentLocation relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateAdjacentLocationRelationship

public AdjacentLocation updateAdjacentLocationRelationship(String userId,
                                                           AdjacentLocation adjacentLocation)
                                                    throws UserNotAuthorizedException,
                                                           MetadataServerUncontactableException,
                                                           InvalidParameterException,
                                                           StatusNotSupportedException,
                                                           UnrecognizedGUIDException

Update AdjacentLocation relationship

Parameters:: userId - user identity; adjacentLocation - relationship
Returns:: AdjacentLocation relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createSemanticAssignmentRelationship

public SemanticAssignment createSemanticAssignmentRelationship(String userId,
                                                               SemanticAssignment relationship)
                                                        throws MetadataServerUncontactableException,
                                                               UserNotAuthorizedException,
                                                               InvalidParameterException,
                                                               UnrecognizedGUIDException,
                                                               StatusNotSupportedException

Create SemanticAssignment relationship

Parameters:: userId - user identity; relationship - SemanticAssignment relationship to create
Returns:: created SemanticAssignment relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getSemanticAssignmentRelationshipByGuid

public SemanticAssignment getSemanticAssignmentRelationshipByGuid(String userId,
                                                                  String relationshipGuid)
                                                           throws MetadataServerUncontactableException,
                                                                  UserNotAuthorizedException,
                                                                  InvalidParameterException,
                                                                  UnrecognizedGUIDException

Get SemanticAssignment relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: SemanticAssignment relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateSemanticAssignmentRelationship

public SemanticAssignment updateSemanticAssignmentRelationship(String userId,
                                                               SemanticAssignment semanticAssignment)
                                                        throws UserNotAuthorizedException,
                                                               MetadataServerUncontactableException,
                                                               InvalidParameterException,
                                                               StatusNotSupportedException,
                                                               UnrecognizedGUIDException

Update SemanticAssignment relationship

Parameters:: userId - user identity; semanticAssignment - relationship
Returns:: SemanticAssignment relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createHostLocationRelationship

public HostLocation createHostLocationRelationship(String userId,
                                                   HostLocation relationship)
                                            throws MetadataServerUncontactableException,
                                                   UserNotAuthorizedException,
                                                   InvalidParameterException,
                                                   UnrecognizedGUIDException,
                                                   StatusNotSupportedException

Create HostLocation relationship

Parameters:: userId - user identity; relationship - HostLocation relationship to create
Returns:: created HostLocation relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getHostLocationRelationshipByGuid

public HostLocation getHostLocationRelationshipByGuid(String userId,
                                                      String relationshipGuid)
                                               throws MetadataServerUncontactableException,
                                                      UserNotAuthorizedException,
                                                      InvalidParameterException,
                                                      UnrecognizedGUIDException

Get HostLocation relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: HostLocation relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateHostLocationRelationship

public HostLocation updateHostLocationRelationship(String userId,
                                                   HostLocation hostLocation)
                                            throws UserNotAuthorizedException,
                                                   MetadataServerUncontactableException,
                                                   InvalidParameterException,
                                                   StatusNotSupportedException,
                                                   UnrecognizedGUIDException

Update HostLocation relationship

Parameters:: userId - user identity; hostLocation - relationship
Returns:: HostLocation relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createRelatedTermRelationship

public RelatedTerm createRelatedTermRelationship(String userId,
                                                 RelatedTerm relationship)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 UnrecognizedGUIDException,
                                                 StatusNotSupportedException

Create RelatedTerm relationship

Parameters:: userId - user identity; relationship - RelatedTerm relationship to create
Returns:: created RelatedTerm relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getRelatedTermRelationshipByGuid

public RelatedTerm getRelatedTermRelationshipByGuid(String userId,
                                                    String relationshipGuid)
                                             throws MetadataServerUncontactableException,
                                                    UserNotAuthorizedException,
                                                    InvalidParameterException,
                                                    UnrecognizedGUIDException

Get RelatedTerm relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: RelatedTerm relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateRelatedTermRelationship

public RelatedTerm updateRelatedTermRelationship(String userId,
                                                 RelatedTerm relatedTerm)
                                          throws UserNotAuthorizedException,
                                                 MetadataServerUncontactableException,
                                                 InvalidParameterException,
                                                 StatusNotSupportedException,
                                                 UnrecognizedGUIDException

Update RelatedTerm relationship

Parameters:: userId - user identity; relatedTerm - relationship
Returns:: RelatedTerm relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createSchemaTypeImplementationRelationship

public SchemaTypeImplementation createSchemaTypeImplementationRelationship(String userId,
                                                                           SchemaTypeImplementation relationship)
                                                                    throws MetadataServerUncontactableException,
                                                                           UserNotAuthorizedException,
                                                                           InvalidParameterException,
                                                                           UnrecognizedGUIDException,
                                                                           StatusNotSupportedException

Create SchemaTypeImplementation relationship

Parameters:: userId - user identity; relationship - SchemaTypeImplementation relationship to create
Returns:: created SchemaTypeImplementation relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getSchemaTypeImplementationRelationshipByGuid

public SchemaTypeImplementation getSchemaTypeImplementationRelationshipByGuid(String userId,
                                                                              String relationshipGuid)
                                                                       throws MetadataServerUncontactableException,
                                                                              UserNotAuthorizedException,
                                                                              InvalidParameterException,
                                                                              UnrecognizedGUIDException

Get SchemaTypeImplementation relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: SchemaTypeImplementation relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateSchemaTypeImplementationRelationship

public SchemaTypeImplementation updateSchemaTypeImplementationRelationship(String userId,
                                                                           SchemaTypeImplementation schemaTypeImplementation)
                                                                    throws UserNotAuthorizedException,
                                                                           MetadataServerUncontactableException,
                                                                           InvalidParameterException,
                                                                           StatusNotSupportedException,
                                                                           UnrecognizedGUIDException

Update SchemaTypeImplementation relationship

Parameters:: userId - user identity; schemaTypeImplementation - relationship
Returns:: SchemaTypeImplementation relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createProcessInputRelationship

public ProcessInput createProcessInputRelationship(String userId,
                                                   ProcessInput relationship)
                                            throws MetadataServerUncontactableException,
                                                   UserNotAuthorizedException,
                                                   InvalidParameterException,
                                                   UnrecognizedGUIDException,
                                                   StatusNotSupportedException

Create ProcessInput relationship

Parameters:: userId - user identity; relationship - ProcessInput relationship to create
Returns:: created ProcessInput relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getProcessInputRelationshipByGuid

public ProcessInput getProcessInputRelationshipByGuid(String userId,
                                                      String relationshipGuid)
                                               throws MetadataServerUncontactableException,
                                                      UserNotAuthorizedException,
                                                      InvalidParameterException,
                                                      UnrecognizedGUIDException

Get ProcessInput relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: ProcessInput relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateProcessInputRelationship

public ProcessInput updateProcessInputRelationship(String userId,
                                                   ProcessInput processInput)
                                            throws UserNotAuthorizedException,
                                                   MetadataServerUncontactableException,
                                                   InvalidParameterException,
                                                   StatusNotSupportedException,
                                                   UnrecognizedGUIDException

Update ProcessInput relationship

Parameters:: userId - user identity; processInput - relationship
Returns:: ProcessInput relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createAPIHeaderRelationship

public APIHeader createAPIHeaderRelationship(String userId,
                                             APIHeader relationship)
                                      throws MetadataServerUncontactableException,
                                             UserNotAuthorizedException,
                                             InvalidParameterException,
                                             UnrecognizedGUIDException,
                                             StatusNotSupportedException

Create APIHeader relationship

Parameters:: userId - user identity; relationship - APIHeader relationship to create
Returns:: created APIHeader relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getAPIHeaderRelationshipByGuid

public APIHeader getAPIHeaderRelationshipByGuid(String userId,
                                                String relationshipGuid)
                                         throws MetadataServerUncontactableException,
                                                UserNotAuthorizedException,
                                                InvalidParameterException,
                                                UnrecognizedGUIDException

Get APIHeader relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: APIHeader relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateAPIHeaderRelationship

public APIHeader updateAPIHeaderRelationship(String userId,
                                             APIHeader aPIHeader)
                                      throws UserNotAuthorizedException,
                                             MetadataServerUncontactableException,
                                             InvalidParameterException,
                                             StatusNotSupportedException,
                                             UnrecognizedGUIDException

Update APIHeader relationship

Parameters:: userId - user identity; aPIHeader - relationship
Returns:: APIHeader relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createLibraryTermReferenceRelationship

public LibraryTermReference createLibraryTermReferenceRelationship(String userId,
                                                                   LibraryTermReference relationship)
                                                            throws MetadataServerUncontactableException,
                                                                   UserNotAuthorizedException,
                                                                   InvalidParameterException,
                                                                   UnrecognizedGUIDException,
                                                                   StatusNotSupportedException

Create LibraryTermReference relationship

Parameters:: userId - user identity; relationship - LibraryTermReference relationship to create
Returns:: created LibraryTermReference relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getLibraryTermReferenceRelationshipByGuid

public LibraryTermReference getLibraryTermReferenceRelationshipByGuid(String userId,
                                                                      String relationshipGuid)
                                                               throws MetadataServerUncontactableException,
                                                                      UserNotAuthorizedException,
                                                                      InvalidParameterException,
                                                                      UnrecognizedGUIDException

Get LibraryTermReference relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: LibraryTermReference relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateLibraryTermReferenceRelationship

public LibraryTermReference updateLibraryTermReferenceRelationship(String userId,
                                                                   LibraryTermReference libraryTermReference)
                                                            throws UserNotAuthorizedException,
                                                                   MetadataServerUncontactableException,
                                                                   InvalidParameterException,
                                                                   StatusNotSupportedException,
                                                                   UnrecognizedGUIDException

Update LibraryTermReference relationship

Parameters:: userId - user identity; libraryTermReference - relationship
Returns:: LibraryTermReference relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createAttachedTagRelationship

public AttachedTag createAttachedTagRelationship(String userId,
                                                 AttachedTag relationship)
                                          throws MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 InvalidParameterException,
                                                 UnrecognizedGUIDException,
                                                 StatusNotSupportedException

Create AttachedTag relationship

Parameters:: userId - user identity; relationship - AttachedTag relationship to create
Returns:: created AttachedTag relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getAttachedTagRelationshipByGuid

public AttachedTag getAttachedTagRelationshipByGuid(String userId,
                                                    String relationshipGuid)
                                             throws MetadataServerUncontactableException,
                                                    UserNotAuthorizedException,
                                                    InvalidParameterException,
                                                    UnrecognizedGUIDException

Get AttachedTag relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: AttachedTag relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateAttachedTagRelationship

public AttachedTag updateAttachedTagRelationship(String userId,
                                                 AttachedTag attachedTag)
                                          throws UserNotAuthorizedException,
                                                 MetadataServerUncontactableException,
                                                 InvalidParameterException,
                                                 StatusNotSupportedException,
                                                 UnrecognizedGUIDException

Update AttachedTag relationship

Parameters:: userId - user identity; attachedTag - relationship
Returns:: AttachedTag relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createTermHASARelationshipRelationship

public TermHASARelationship createTermHASARelationshipRelationship(String userId,
                                                                   TermHASARelationship relationship)
                                                            throws MetadataServerUncontactableException,
                                                                   UserNotAuthorizedException,
                                                                   InvalidParameterException,
                                                                   UnrecognizedGUIDException,
                                                                   StatusNotSupportedException

Create TermHASARelationship relationship

Parameters:: userId - user identity; relationship - TermHASARelationship relationship to create
Returns:: created TermHASARelationship relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getTermHASARelationshipRelationshipByGuid

public TermHASARelationship getTermHASARelationshipRelationshipByGuid(String userId,
                                                                      String relationshipGuid)
                                                               throws MetadataServerUncontactableException,
                                                                      UserNotAuthorizedException,
                                                                      InvalidParameterException,
                                                                      UnrecognizedGUIDException

Get TermHASARelationship relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: TermHASARelationship relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateTermHASARelationshipRelationship

public TermHASARelationship updateTermHASARelationshipRelationship(String userId,
                                                                   TermHASARelationship termHASARelationship)
                                                            throws UserNotAuthorizedException,
                                                                   MetadataServerUncontactableException,
                                                                   InvalidParameterException,
                                                                   StatusNotSupportedException,
                                                                   UnrecognizedGUIDException

Update TermHASARelationship relationship

Parameters:: userId - user identity; termHASARelationship - relationship
Returns:: TermHASARelationship relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createGovernanceProcessImplementationRelationship

public GovernanceProcessImplementation createGovernanceProcessImplementationRelationship(String userId,
                                                                                         GovernanceProcessImplementation relationship)
                                                                                  throws MetadataServerUncontactableException,
                                                                                         UserNotAuthorizedException,
                                                                                         InvalidParameterException,
                                                                                         UnrecognizedGUIDException,
                                                                                         StatusNotSupportedException

Create GovernanceProcessImplementation relationship

Parameters:: userId - user identity; relationship - GovernanceProcessImplementation relationship to create
Returns:: created GovernanceProcessImplementation relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getGovernanceProcessImplementationRelationshipByGuid

public GovernanceProcessImplementation getGovernanceProcessImplementationRelationshipByGuid(String userId,
                                                                                            String relationshipGuid)
                                                                                     throws MetadataServerUncontactableException,
                                                                                            UserNotAuthorizedException,
                                                                                            InvalidParameterException,
                                                                                            UnrecognizedGUIDException

Get GovernanceProcessImplementation relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: GovernanceProcessImplementation relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateGovernanceProcessImplementationRelationship

public GovernanceProcessImplementation updateGovernanceProcessImplementationRelationship(String userId,
                                                                                         GovernanceProcessImplementation governanceProcessImplementation)
                                                                                  throws UserNotAuthorizedException,
                                                                                         MetadataServerUncontactableException,
                                                                                         InvalidParameterException,
                                                                                         StatusNotSupportedException,
                                                                                         UnrecognizedGUIDException

Update GovernanceProcessImplementation relationship

Parameters:: userId - user identity; governanceProcessImplementation - relationship
Returns:: GovernanceProcessImplementation relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createGroupedMediaRelationship

public GroupedMedia createGroupedMediaRelationship(String userId,
                                                   GroupedMedia relationship)
                                            throws MetadataServerUncontactableException,
                                                   UserNotAuthorizedException,
                                                   InvalidParameterException,
                                                   UnrecognizedGUIDException,
                                                   StatusNotSupportedException

Create GroupedMedia relationship

Parameters:: userId - user identity; relationship - GroupedMedia relationship to create
Returns:: created GroupedMedia relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getGroupedMediaRelationshipByGuid

public GroupedMedia getGroupedMediaRelationshipByGuid(String userId,
                                                      String relationshipGuid)
                                               throws MetadataServerUncontactableException,
                                                      UserNotAuthorizedException,
                                                      InvalidParameterException,
                                                      UnrecognizedGUIDException

Get GroupedMedia relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: GroupedMedia relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateGroupedMediaRelationship

public GroupedMedia updateGroupedMediaRelationship(String userId,
                                                   GroupedMedia groupedMedia)
                                            throws UserNotAuthorizedException,
                                                   MetadataServerUncontactableException,
                                                   InvalidParameterException,
                                                   StatusNotSupportedException,
                                                   UnrecognizedGUIDException

Update GroupedMedia relationship

Parameters:: userId - user identity; groupedMedia - relationship
Returns:: GroupedMedia relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createGovernanceResponseRelationship

public GovernanceResponse createGovernanceResponseRelationship(String userId,
                                                               GovernanceResponse relationship)
                                                        throws MetadataServerUncontactableException,
                                                               UserNotAuthorizedException,
                                                               InvalidParameterException,
                                                               UnrecognizedGUIDException,
                                                               StatusNotSupportedException

Create GovernanceResponse relationship

Parameters:: userId - user identity; relationship - GovernanceResponse relationship to create
Returns:: created GovernanceResponse relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getGovernanceResponseRelationshipByGuid

public GovernanceResponse getGovernanceResponseRelationshipByGuid(String userId,
                                                                  String relationshipGuid)
                                                           throws MetadataServerUncontactableException,
                                                                  UserNotAuthorizedException,
                                                                  InvalidParameterException,
                                                                  UnrecognizedGUIDException

Get GovernanceResponse relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: GovernanceResponse relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateGovernanceResponseRelationship

public GovernanceResponse updateGovernanceResponseRelationship(String userId,
                                                               GovernanceResponse governanceResponse)
                                                        throws UserNotAuthorizedException,
                                                               MetadataServerUncontactableException,
                                                               InvalidParameterException,
                                                               StatusNotSupportedException,
                                                               UnrecognizedGUIDException

Update GovernanceResponse relationship

Parameters:: userId - user identity; governanceResponse - relationship
Returns:: GovernanceResponse relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createNestedFileRelationship

public NestedFile createNestedFileRelationship(String userId,
                                               NestedFile relationship)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               InvalidParameterException,
                                               UnrecognizedGUIDException,
                                               StatusNotSupportedException

Create NestedFile relationship

Parameters:: userId - user identity; relationship - NestedFile relationship to create
Returns:: created NestedFile relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getNestedFileRelationshipByGuid

public NestedFile getNestedFileRelationshipByGuid(String userId,
                                                  String relationshipGuid)
                                           throws MetadataServerUncontactableException,
                                                  UserNotAuthorizedException,
                                                  InvalidParameterException,
                                                  UnrecognizedGUIDException

Get NestedFile relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: NestedFile relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateNestedFileRelationship

public NestedFile updateNestedFileRelationship(String userId,
                                               NestedFile nestedFile)
                                        throws UserNotAuthorizedException,
                                               MetadataServerUncontactableException,
                                               InvalidParameterException,
                                               StatusNotSupportedException,
                                               UnrecognizedGUIDException

Update NestedFile relationship

Parameters:: userId - user identity; nestedFile - relationship
Returns:: NestedFile relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createHostOperatingPlatformRelationship

public HostOperatingPlatform createHostOperatingPlatformRelationship(String userId,
                                                                     HostOperatingPlatform relationship)
                                                              throws MetadataServerUncontactableException,
                                                                     UserNotAuthorizedException,
                                                                     InvalidParameterException,
                                                                     UnrecognizedGUIDException,
                                                                     StatusNotSupportedException

Create HostOperatingPlatform relationship

Parameters:: userId - user identity; relationship - HostOperatingPlatform relationship to create
Returns:: created HostOperatingPlatform relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getHostOperatingPlatformRelationshipByGuid

public HostOperatingPlatform getHostOperatingPlatformRelationshipByGuid(String userId,
                                                                        String relationshipGuid)
                                                                 throws MetadataServerUncontactableException,
                                                                        UserNotAuthorizedException,
                                                                        InvalidParameterException,
                                                                        UnrecognizedGUIDException

Get HostOperatingPlatform relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: HostOperatingPlatform relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateHostOperatingPlatformRelationship

public HostOperatingPlatform updateHostOperatingPlatformRelationship(String userId,
                                                                     HostOperatingPlatform hostOperatingPlatform)
                                                              throws UserNotAuthorizedException,
                                                                     MetadataServerUncontactableException,
                                                                     InvalidParameterException,
                                                                     StatusNotSupportedException,
                                                                     UnrecognizedGUIDException

Update HostOperatingPlatform relationship

Parameters:: userId - user identity; hostOperatingPlatform - relationship
Returns:: HostOperatingPlatform relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createTermAnchorRelationship

public TermAnchor createTermAnchorRelationship(String userId,
                                               TermAnchor relationship)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               InvalidParameterException,
                                               UnrecognizedGUIDException,
                                               StatusNotSupportedException

Create TermAnchor relationship

Parameters:: userId - user identity; relationship - TermAnchor relationship to create
Returns:: created TermAnchor relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getTermAnchorRelationshipByGuid

public TermAnchor getTermAnchorRelationshipByGuid(String userId,
                                                  String relationshipGuid)
                                           throws MetadataServerUncontactableException,
                                                  UserNotAuthorizedException,
                                                  InvalidParameterException,
                                                  UnrecognizedGUIDException

Get TermAnchor relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: TermAnchor relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateTermAnchorRelationship

public TermAnchor updateTermAnchorRelationship(String userId,
                                               TermAnchor termAnchor)
                                        throws UserNotAuthorizedException,
                                               MetadataServerUncontactableException,
                                               InvalidParameterException,
                                               StatusNotSupportedException,
                                               UnrecognizedGUIDException

Update TermAnchor relationship

Parameters:: userId - user identity; termAnchor - relationship
Returns:: TermAnchor relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createAPIRequestRelationship

public APIRequest createAPIRequestRelationship(String userId,
                                               APIRequest relationship)
                                        throws MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               InvalidParameterException,
                                               UnrecognizedGUIDException,
                                               StatusNotSupportedException

Create APIRequest relationship

Parameters:: userId - user identity; relationship - APIRequest relationship to create
Returns:: created APIRequest relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getAPIRequestRelationshipByGuid

public APIRequest getAPIRequestRelationshipByGuid(String userId,
                                                  String relationshipGuid)
                                           throws MetadataServerUncontactableException,
                                                  UserNotAuthorizedException,
                                                  InvalidParameterException,
                                                  UnrecognizedGUIDException

Get APIRequest relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: APIRequest relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateAPIRequestRelationship

public APIRequest updateAPIRequestRelationship(String userId,
                                               APIRequest aPIRequest)
                                        throws UserNotAuthorizedException,
                                               MetadataServerUncontactableException,
                                               InvalidParameterException,
                                               StatusNotSupportedException,
                                               UnrecognizedGUIDException

Update APIRequest relationship

Parameters:: userId - user identity; aPIRequest - relationship
Returns:: APIRequest relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createCohortMemberMetadataCollectionRelationship

public CohortMemberMetadataCollection createCohortMemberMetadataCollectionRelationship(String userId,
                                                                                       CohortMemberMetadataCollection relationship)
                                                                                throws MetadataServerUncontactableException,
                                                                                       UserNotAuthorizedException,
                                                                                       InvalidParameterException,
                                                                                       UnrecognizedGUIDException,
                                                                                       StatusNotSupportedException

Create CohortMemberMetadataCollection relationship

Parameters:: userId - user identity; relationship - CohortMemberMetadataCollection relationship to create
Returns:: created CohortMemberMetadataCollection relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getCohortMemberMetadataCollectionRelationshipByGuid

public CohortMemberMetadataCollection getCohortMemberMetadataCollectionRelationshipByGuid(String userId,
                                                                                          String relationshipGuid)
                                                                                   throws MetadataServerUncontactableException,
                                                                                          UserNotAuthorizedException,
                                                                                          InvalidParameterException,
                                                                                          UnrecognizedGUIDException

Get CohortMemberMetadataCollection relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: CohortMemberMetadataCollection relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateCohortMemberMetadataCollectionRelationship

public CohortMemberMetadataCollection updateCohortMemberMetadataCollectionRelationship(String userId,
                                                                                       CohortMemberMetadataCollection cohortMemberMetadataCollection)
                                                                                throws UserNotAuthorizedException,
                                                                                       MetadataServerUncontactableException,
                                                                                       InvalidParameterException,
                                                                                       StatusNotSupportedException,
                                                                                       UnrecognizedGUIDException

Update CohortMemberMetadataCollection relationship

Parameters:: userId - user identity; cohortMemberMetadataCollection - relationship
Returns:: CohortMemberMetadataCollection relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createReferenceableFacetRelationship

public ReferenceableFacet createReferenceableFacetRelationship(String userId,
                                                               ReferenceableFacet relationship)
                                                        throws MetadataServerUncontactableException,
                                                               UserNotAuthorizedException,
                                                               InvalidParameterException,
                                                               UnrecognizedGUIDException,
                                                               StatusNotSupportedException

Create ReferenceableFacet relationship

Parameters:: userId - user identity; relationship - ReferenceableFacet relationship to create
Returns:: created ReferenceableFacet relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getReferenceableFacetRelationshipByGuid

public ReferenceableFacet getReferenceableFacetRelationshipByGuid(String userId,
                                                                  String relationshipGuid)
                                                           throws MetadataServerUncontactableException,
                                                                  UserNotAuthorizedException,
                                                                  InvalidParameterException,
                                                                  UnrecognizedGUIDException

Get ReferenceableFacet relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: ReferenceableFacet relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateReferenceableFacetRelationship

public ReferenceableFacet updateReferenceableFacetRelationship(String userId,
                                                               ReferenceableFacet referenceableFacet)
                                                        throws UserNotAuthorizedException,
                                                               MetadataServerUncontactableException,
                                                               InvalidParameterException,
                                                               StatusNotSupportedException,
                                                               UnrecognizedGUIDException

Update ReferenceableFacet relationship

Parameters:: userId - user identity; referenceableFacet - relationship
Returns:: ReferenceableFacet relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

createAttachedLikeRelationship

public AttachedLike createAttachedLikeRelationship(String userId,
                                                   AttachedLike relationship)
                                            throws MetadataServerUncontactableException,
                                                   UserNotAuthorizedException,
                                                   InvalidParameterException,
                                                   UnrecognizedGUIDException,
                                                   StatusNotSupportedException

Create AttachedLike relationship

Parameters:: userId - user identity; relationship - AttachedLike relationship to create
Returns:: created AttachedLike relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

getAttachedLikeRelationshipByGuid

public AttachedLike getAttachedLikeRelationshipByGuid(String userId,
                                                      String relationshipGuid)
                                               throws MetadataServerUncontactableException,
                                                      UserNotAuthorizedException,
                                                      InvalidParameterException,
                                                      UnrecognizedGUIDException

Get AttachedLike relationship

Parameters:: userId - user identity; relationshipGuid - relationship guid
Returns:: AttachedLike relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

updateAttachedLikeRelationship

public AttachedLike updateAttachedLikeRelationship(String userId,
                                                   AttachedLike attachedLike)
                                            throws UserNotAuthorizedException,
                                                   MetadataServerUncontactableException,
                                                   InvalidParameterException,
                                                   StatusNotSupportedException,
                                                   UnrecognizedGUIDException

Update AttachedLike relationship

Parameters:: userId - user identity; attachedLike - relationship
Returns:: AttachedLike relationship
Throws:: MetadataServerUncontactableException - not able to communicate with the metadata server.; UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.; InvalidParameterException - a parameter is null or an invalid value.; UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.; StatusNotSupportedException - status is not supported

deleteRelationshipById
```
public Relationship deleteRelationshipById(String userId,
                                           String relationshipGuid,
                                           String typeName)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           InvalidParameterException,
                                           FunctionNotSupportedException,
                                           UnrecognizedGUIDException
```
Delete relationship. Any checking that the relationship is of a particular type should be done by the caller.

Parameters:

userId - user identity

relationshipGuid - relationshipGuid

typeName - name of the type. This needs match the type associated with the relationship identified with the supplied GUID

Returns:

deleted relationship

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

FunctionNotSupportedException - a function is not supported.

purgeRelationshipById
```
public void purgeRelationshipById(String userId,
                                  String relationshipGuid,
                                  String typeName)
                           throws MetadataServerUncontactableException,
                                  UserNotAuthorizedException,
                                  InvalidParameterException,
                                  UnrecognizedGUIDException,
                                  RelationshipNotDeletedException,
                                  GUIDNotPurgedException
```
Purge relationship

Parameters:

userId - user identity

relationshipGuid - relationshipGuid

typeName - name of the type. This needs match the type associated with the relationship identified with the supplied GUID

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

RelationshipNotDeletedException - the relationship could not be deleted.

GUIDNotPurgedException - the unique identifier (guid) used to purge an object did not result in the object being purged.

restoreRelationship
```
public Relationship restoreRelationship(String userId,
                                        String relationshipGuid)
                                 throws MetadataServerUncontactableException,
                                        UserNotAuthorizedException,
                                        InvalidParameterException,
                                        UnrecognizedGUIDException,
                                        GUIDNotDeletedException,
                                        FunctionNotSupportedException
```
Restore an relationship identified by its GUID. Restore resurrects a soft deleted relationship. When a relationship is incorrectly deleted, the delete can be undone by using this restore.

Parameters:

userId - user identity

relationshipGuid - GUID for the relationship

Returns:

Relationship the restored relationship

Throws:

MetadataServerUncontactableException - not able to communicate with the metadata server.

UserNotAuthorizedException - the userId passed on the request is not authorized to perform the requested action.

InvalidParameterException - a parameter is null or an invalid value.

UnrecognizedGUIDException - the unique identifier (guid) used to request an object is either unrecognized, or is the identifier for a different type of object.

GUIDNotDeletedException - the guid of the relationship is not deleted, so it cannot be restored

FunctionNotSupportedException - Function not supported

Class SubjectAreaBeansToAccessOMRS

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SubjectAreaBeansToAccessOMRS

Method Detail

setOMRSAPIHelper

getCertificationTypeById

createCertificationType

updateCertificationType

deleteCertificationTypeByGuid

purgeCertificationTypeByGuid

restoreCertificationType

addCertificationTypeClassifications

updateCertificationTypeClassification

deleteCertificationTypeClassification

getCertificationTypeRelationships

getAPISchemaTypeById

createAPISchemaType

updateAPISchemaType

deleteAPISchemaTypeByGuid

purgeAPISchemaTypeByGuid

restoreAPISchemaType

addAPISchemaTypeClassifications

updateAPISchemaTypeClassification

deleteAPISchemaTypeClassification

getAPISchemaTypeRelationships

getDataSetById

createDataSet

updateDataSet

deleteDataSetByGuid

purgeDataSetByGuid

restoreDataSet

addDataSetClassifications

updateDataSetClassification

deleteDataSetClassification

getDataSetRelationships

getOperatingPlatformById

createOperatingPlatform

updateOperatingPlatform

deleteOperatingPlatformByGuid

purgeOperatingPlatformByGuid

restoreOperatingPlatform

addOperatingPlatformClassifications

updateOperatingPlatformClassification

deleteOperatingPlatformClassification

getOperatingPlatformRelationships

getGovernancePolicyById

createGovernancePolicy

updateGovernancePolicy

deleteGovernancePolicyByGuid

purgeGovernancePolicyByGuid

restoreGovernancePolicy

addGovernancePolicyClassifications

updateGovernancePolicyClassification

deleteGovernancePolicyClassification

getGovernancePolicyRelationships

getDerivedSchemaAttributeById

createDerivedSchemaAttribute

updateDerivedSchemaAttribute

deleteDerivedSchemaAttributeByGuid

purgeDerivedSchemaAttributeByGuid

restoreDerivedSchemaAttribute

addDerivedSchemaAttributeClassifications

updateDerivedSchemaAttributeClassification

deleteDerivedSchemaAttributeClassification

getDerivedSchemaAttributeRelationships

getProcessById

createProcess

updateProcess

deleteProcessByGuid

purgeProcessByGuid

restoreProcess

addProcessClassifications

updateProcessClassification

deleteProcessClassification

getProcessRelationships

getMapSchemaTypeById

createMapSchemaType