Package org.odpi.openmetadata.commonservices.ffdc.rest

Interface FFDCResponse

All Known Implementing Classes:
AccessServiceConfigResponse, AccessServicesResponse, ActorProfileResponse, ActorProfilesResponse, AdminServicesAPIResponse, AnnotationResponse, AnnotationsResponse, APIOperationResponse, APIOperationResponse, APIOperationsResponse, APIOperationsResponse, APIParameterListResponse, APIParameterListsResponse, APIParameterResponse, APIParametersResponse, APIResponse, APIsResponse, AppointeesResponse, AssetCatalogListResponse, AssetCatalogOMASAPIResponse, AssetCatalogResponse, AssetCatalogSupportedTypes, AssetElementResponse, AssetElementsResponse, AssetElementsResponse, AssetGraphResponse, AssetLineageGraphResponse, AssetListResponse, AssetManagerOMASAPIResponse, AssetRelationshipsResponse, AssetResponse, AssetResponse, AssetSearchMatchesListResponse, AssetsResponse, AttributeTypeDefListResponse, AttributeTypeDefResponse, BasicServerPropertiesResponse, BooleanResponse, CatalogTargetResponse, CatalogTargetResponse, CatalogTargetsResponse, CatalogTargetsResponse, CertificationsResponse, CertificationsResponse, CertificationTypeResponse, CertificationTypesResponse, ClassificationListResponse, CohortConfigResponse, CollectionMemberResponse, CollectionMembersResponse, CollectionResponse, CollectionsResponse, CommentElementResponse, CommentElementsResponse, CommentElementsResponse, CommentResponse, CommentResponse, CommentsResponse, CommentTypeListResponse, CommentTypesResponse, CommunitiesResponse, CommunityProfileOMASAPIResponse, CommunityResponse, ConnectionListResponse, ConnectionResponse, ConnectionResponse, ConnectionResponse, ConnectionResponse, ConnectionsResponse, ConnectionsResponse, ConnectionsResponse, ConnectorReportResponse, ConnectorTypeResponse, ConnectorTypeResponse, ConnectorTypesResponse, ConnectorTypesResponse, ControlFlowElementResponse, ControlFlowElementsResponse, CountResponse, DataAssetElementResponse, DataAssetElementsResponse, DatabaseColumnResponse, DatabaseColumnsResponse, DatabaseResponse, DatabaseSchemaResponse, DatabaseSchemasResponse, DatabasesResponse, DatabaseTableResponse, DatabaseTablesResponse, DatabaseViewResponse, DatabaseViewsResponse, DataContainerResponse, DataContainersResponse, DataFieldResponse, DataFieldsResponse, DataFileResponse, DataFilesResponse, DataFlowElementResponse, DataFlowElementsResponse, DataManagerOMASAPIResponse, DataScienceOMASAPIResponse, DedicatedTopicListResponse, DesignModelOMASAPIResponse, DigitalServiceResponse, DigitalServicesResponse, DuplicatesResponse, EffectiveTimeQueryRequestBody, ElementHeaderResponse, ElementHeaderResponse, ElementHeadersResponse, ElementHeadersResponse, ElementStubResponse, ElementStubsResponse, EndpointResponse, EndpointResponse, EndpointsResponse, EndpointsResponse, EngineActionElementResponse, EngineActionElementsResponse, EngineHostServicesResponse, EngineServiceConfigResponse, EventBusConfigResponse, EventTypeResponse, EventTypesResponse, ExternalGlossaryLinkElementsResponse, ExternalIdentifiersResponse, ExternalReferenceElementResponse, ExternalReferenceElementsResponse, ExternalReferenceLinkElementResponse, ExternalReferenceLinkElementsResponse, ExternalReferenceResponse, ExternalReferencesResponse, ExternalReferencesResponse, FFDCResponseBase, FileFolderResponse, FileFoldersResponse, FileSystemResponse, FirstGovernanceActionProcessStepResponse, FormResponse, FormsResponse, GlossaryCategoryElementResponse, GlossaryCategoryElementsResponse, GlossaryElementResponse, GlossaryElementsResponse, GlossaryTermActivityTypeListResponse, GlossaryTermActivityTypeListResponse, GlossaryTermElementResponse, GlossaryTermElementsResponse, GlossaryTermListResponse, GlossaryTermRelationshipStatusListResponse, GlossaryTermRelationshipStatusListResponse, GlossaryTermResponse, GlossaryTermStatusListResponse, GlossaryTermStatusListResponse, GovernanceActionElementResponse, GovernanceActionElementsResponse, GovernanceActionProcessElementResponse, GovernanceActionProcessElementResponse, GovernanceActionProcessElementsResponse, GovernanceActionProcessElementsResponse, GovernanceActionProcessGraphResponse, GovernanceActionProcessStepResponse, GovernanceActionProcessStepsResponse, GovernanceActionStatusResponse, GovernanceActionTypeElementResponse, GovernanceActionTypeElementsResponse, GovernanceActionTypeResponse, GovernanceActionTypesResponse, GovernanceDefinitionGraphResponse, GovernanceDefinitionResponse, GovernanceDefinitionsResponse, GovernanceDefinitionsResponse, GovernanceDomainResponse, GovernanceDomainSetResponse, GovernanceDomainSetsResponse, GovernanceDomainsResponse, GovernanceEngineElementResponse, GovernanceEngineElementResponse, GovernanceEngineElementsResponse, GovernanceEngineElementsResponse, GovernanceEngineOMASAPIResponse, GovernanceEngineSummariesResponse, GovernanceEngineSummaryResponse, GovernanceLevelIdentifierResponse, GovernanceLevelIdentifierSetResponse, GovernanceLevelIdentifierSetsResponse, GovernanceLevelIdentifiersResponse, GovernanceMetricImplementationsResponse, GovernanceMetricResponse, GovernanceMetricsResponse, GovernanceRoleAppointeesResponse, GovernanceRoleHistoryResponse, GovernanceRoleResponse, GovernanceRolesResponse, GovernanceServiceElementResponse, GovernanceServiceElementResponse, GovernanceServiceElementsResponse, GovernanceServiceElementsResponse, GovernanceStatusIdentifierResponse, GovernanceStatusIdentifierSetResponse, GovernanceStatusIdentifierSetsResponse, GovernanceZoneDefinitionResponse, GovernanceZoneResponse, GovernanceZonesResponse, GUIDListResponse, GUIDResponse, HistoryExternalIdentifiersRequestBody, HostResponse, HostsResponse, InformalTagResponse, InformalTagResponse, InformalTagResponse, InformalTagsResponse, InformalTagsResponse, InformalTagsResponse, InformalTagsResponse, IntegrationConnectorElementResponse, IntegrationConnectorElementResponse, IntegrationConnectorElementsResponse, IntegrationConnectorElementsResponse, IntegrationDaemonServicesResponse, IntegrationDaemonStatusResponse, IntegrationGroupElementResponse, IntegrationGroupElementResponse, IntegrationGroupElementsResponse, IntegrationGroupElementsResponse, IntegrationGroupsResponse, IntegrationGroupSummariesResponse, IntegrationGroupSummaryResponse, IntegrationReportResponse, IntegrationReportsResponse, IntegrationServiceConfigResponse, IntegrationServicesResponse, IntegrationServiceSummaryResponse, ITInfrastructureOMASAPIResponse, ITProfileResponse, ITProfilesResponse, LicensesResponse, LicensesResponse, LicenseTypeResponse, LicenseTypesResponse, LikeElementResponse, LikeElementsResponse, LikeElementsResponse, LikesResponse, LineageMappingElementResponse, LineageMappingElementsResponse, LineageNodeNamesResponse, LineageResponse, LineageSearchResponse, LineageTypesResponse, LineageVertexResponse, LocalRepositoryConfigResponse, LocationResponse, LocationsResponse, LocationsResponse, MeaningResponse, MeaningResponse, MeaningsResponse, MeaningsResponse, MetadataCorrelationHeadersResponse, MetadataCorrelationHeadersResponse, MetadataElementSummariesResponse, MetadataElementSummaryResponse, MetadataRelationshipSummariesResponse, MetadataSourceResponse, MoreInformationResponse, NameListResponse, NextGovernanceActionProcessStepsResponse, NextGovernanceActionTypeElementsResponse, NoteElementResponse, NoteElementsResponse, NoteLogElementResponse, NoteLogElementsResponse, NoteLogResponse, NoteLogResponse, NoteLogsResponse, NoteLogsResponse, NoteResponse, NotesResponse, NotesResponse, OCFConnectionResponse, OCFConnectorTypeResponse, OCFConnectorTypesResponse, OCFOMASAPIResponse, OMAGGAFAPIResponse, OMAGOIFAPIResponse, OMAGServerConfigResponse, OMAGServerConfigsResponse, OMAGServerStatusResponse, OMAGServerStatusResponse, OpenMetadataElementResponse, OpenMetadataElementsResponse, OpenMetadataElementsResponse, OpenMetadataGraphResponse, OpenMetadataRelationshipListResponse, OpenMetadataRelationshipResponse, PagedResponse, PersonalProfileResponse, PersonalProfilesResponse, PersonRoleAppointeesResponse, PersonRoleResponse, PersonRolesResponse, PlatformReportResponse, PortElementResponse, PortElementResponse, PortElementsResponse, PortElementsResponse, ProcessCallElementResponse, ProcessCallElementsResponse, ProcessElementResponse, ProcessElementResponse, ProcessElementsResponse, ProcessElementsResponse, ProjectMemberResponse, ProjectMembersResponse, ProjectResponse, ProjectsResponse, PropertiesResponse, QueriesResponse, QueryResponse, RatingElementResponse, RatingElementsResponse, RatingElementsResponse, RatingResponse, RatingsResponse, RatingsResponse, ReferenceablesResponse, ReferenceValueAssignmentDefinitionsResponse, ReferenceValueAssignmentItemsResponse, RegisteredGovernanceServiceResponse, RegisteredGovernanceServiceResponse, RegisteredGovernanceServicesResponse, RegisteredGovernanceServicesResponse, RegisteredIntegrationConnectorResponse, RegisteredIntegrationConnectorResponse, RegisteredIntegrationConnectorsResponse, RegisteredIntegrationConnectorsResponse, RegisteredOMAGServicesResponse, RelatedAssetsResponse, RelatedAssetsResponse, RelatedElementsResponse, RelatedElementsResponse, RelatedMediaReferencesResponse, RelatedMetadataElementListResponse, RelatedMetadataElementListResponse, RelatedMetadataElementsListResponse, RelatedMetadataElementSummariesResponse, RelationshipElementResponse, RelationshipElementResponse, RelationshipElementsResponse, RelationshipElementsResponse, RelationshipListResponse, RelationshipResponse, ReportResponse, ReportsResponse, SchemaAttributeElementResponse, SchemaAttributeElementsResponse, SchemaAttributeResponse, SchemaAttributesResponse, SchemaAttributesResponse, SchemaTypeElementResponse, SchemaTypeElementResponse, SchemaTypeElementsResponse, SchemaTypeElementsResponse, SchemaTypeResponse, SchemaTypeResponse, SchemaTypesResponse, SecurityGroupResponse, SecurityGroupsResponse, ServerAssetUseResponse, ServerAssetUsesResponse, ServerListResponse, ServerReportResponse, ServerServicesListResponse, ServerStatusResponse, ServerTypeClassificationResponse, SoftwareCapabilitiesResponse, SoftwareCapabilityResponse, SoftwareDeveloperOMASAPIResponse, SoftwareServerPlatformResponse, SoftwareServerPlatformsResponse, SoftwareServerResponse, SoftwareServersResponse, StringMapResponse, StringResponse, SubjectAreaDefinitionResponse, SubjectAreaResponse, SubjectAreasResponse, SuccessMessageResponse, SuccessMessageResponse, SupportedCapabilitiesResponse, SurveyReportsResponse, TagResponse, TagsResponse, TechnologyTypeElementListResponse, TechnologyTypeHierarchyResponse, TechnologyTypeReportResponse, TechnologyTypeSummaryListResponse, TemplateElementResponse, TemplateElementsResponse, TermAssignmentStatusesResponse, ToDoResponse, ToDosResponse, TopicResponse, TopicsResponse, TranslationDetailResponse, TranslationListResponse, TypeDefGalleryResponse, TypeDefListResponse, TypeDefResponse, UserIdentitiesResponse, UserIdentityListResponse, UserIdentityResponse, UserIdentityResponse, ValidMetadataValueDetailListResponse, ValidMetadataValueListResponse, ValidMetadataValueResponse, ValidValueAssignmentConsumersResponse, ValidValueAssignmentDefinitionsResponse, ValidValueListResponse, ValidValueMappingsResponse, ValidValueResponse, ValidValueResponse, ValidValueResponse, ValidValueSetsResponse, ValidValuesImplAssetsResponse, ValidValuesImplDefinitionsResponse, ValidValuesMappingsResponse, ValidValuesResponse, ValidValuesResponse, ViewServiceConfigResponse, ViewServicesResponse, VoidResponse
public interface FFDCResponse
FFDCResponse is the top-level class for a response object used to return results on REST APIs.

  • Method Details

    • getRelatedHTTPCode

      int getRelatedHTTPCode()
      Return the HTTP Code to use if forwarding response to HTTP client.
      Returns:
      integer HTTP status code

    • getExceptionClassName

      String getExceptionClassName()
      Return the name of the Java class name to use to recreate the exception.
      Returns:
      String name of the fully-qualified java class name

    • getExceptionCausedBy

      String getExceptionCausedBy()
      Return the name of any nested exception that may indicate the root cause of the exception.
      Returns:
      exception class name

    • getActionDescription

      String getActionDescription()
      Return the description of the action in progress when the exception occurred.
      Returns:
      string description

    • getExceptionErrorMessage

      String getExceptionErrorMessage()
      Return the error message associated with the exception.
      Returns:
      string error message

    • getExceptionErrorMessageId

      String getExceptionErrorMessageId()
      Return the formal message identifier for the error message. This is incorporated in the error message. This is provided both for automated processing and to enable the error message to be reformatted in a different language.
      Returns:
      string identifier

    • getExceptionErrorMessageParameters

      String[] getExceptionErrorMessageParameters()
      Return the parameters that were inserted in the error message. These are provided both for automated processing and to enable the error message to be reformatted in a different language.
      Returns:
      array of strings

    • getExceptionSystemAction

      String getExceptionSystemAction()
      Return the description of the action taken by the system as a result of the exception.
      Returns:
      - string description of the action taken

    • getExceptionUserAction

      String getExceptionUserAction()
      Return the action that a user should take to resolve the problem.
      Returns:
      string instructions

    • getExceptionProperties

      Map<String,Object> getExceptionProperties()
      Return the additional properties stored by the exceptions.
      Returns:
      property map

    • setRelatedHTTPCode

      void setRelatedHTTPCode(int relatedHTTPCode)
      Set up the HTTP Code to use if forwarding response to HTTP client.
      Parameters:
      relatedHTTPCode - - integer HTTP status code

    • setExceptionClassName

      void setExceptionClassName(String exceptionClassName)
      Set up the name of the Java class name to use to recreate the exception.
      Parameters:
      exceptionClassName - - String name of the fully-qualified java class name

    • setExceptionCausedBy

      void setExceptionCausedBy(String exceptionCausedBy)
      Set up the name of any nested exception that may indicate the root cause of the exception.
      Parameters:
      exceptionCausedBy - exception class name

    • setActionDescription

      void setActionDescription(String actionDescription)
      Set up the description of the activity in progress when the exception occurred.
      Parameters:
      actionDescription - string description

    • setExceptionErrorMessage

      void setExceptionErrorMessage(String exceptionErrorMessage)
      Set up the error message associated with the exception.
      Parameters:
      exceptionErrorMessage - - string error message

    • setExceptionErrorMessageId

      void setExceptionErrorMessageId(String exceptionErrorMessageId)
      Set up the formal message identifier for the error message. This is incorporated in the error message. This is provided both for automated processing and to enable the error message to be reformatted in a different language.
      Parameters:
      exceptionErrorMessageId - string identifier

    • setExceptionErrorMessageParameters

      void setExceptionErrorMessageParameters(String[] exceptionErrorMessageParameters)
      Set up the list of parameters inserted in to the error message. These are provided both for automated processing and to enable the error message to be reformatted in a different language.
      Parameters:
      exceptionErrorMessageParameters - list of strings

    • setExceptionSystemAction

      void setExceptionSystemAction(String exceptionSystemAction)
      Set up the description of the action taken by the system as a result of the exception.
      Parameters:
      exceptionSystemAction - - string description of the action taken

    • setExceptionUserAction

      void setExceptionUserAction(String exceptionUserAction)
      Set up the action that a user should take to resolve the problem.
      Parameters:
      exceptionUserAction - - string instructions

    • setExceptionProperties

      void setExceptionProperties(Map<String,Object> exceptionProperties)
      Set up the additional properties stored by the exceptions.
      Parameters:
      exceptionProperties - property map