Package org.projecthusky.communication.ch.xd.storedquery

Class GetFolderAndContentsQuery

java.lang.Object
org.projecthusky.communication.xd.storedquery.AbstractStoredQuery
org.projecthusky.communication.ch.xd.storedquery.GetFolderAndContentsQuery
All Implemented Interfaces:
StoredQueryInterface
public class GetFolderAndContentsQuery extends AbstractStoredQuery
Represents a query to get folders and its contents (associations, documents) from an XDS Registry. This class uses only enums for XDS metadata which are specified by eHealth Suisse for the usage in Switzerland.

  • Constructor Details

    • GetFolderAndContentsQuery

      public GetFolderAndContentsQuery(String folderId, boolean isUUID, FormatCode[] formatCodes, ConfidentialityCode[] confidentialityCodes)
      Constructor. All arrays of codes are interpreted with as a disjunction (OR - semantics).
      Parameters:
      folderId - id of the folder (either uniqueId or entryUUID) (required)
      isUUID - set to true if folderID is the entryUUID (internal registry identifier) of the folder and set to false if it is the uniqueID (external to registry) of the folder. In most user cases, this should be set to false
      formatCodes - array of formatCodes to query for (can be null)
      confidentialityCodes - array of confidentiality codes to query for (can be null)

    • GetFolderAndContentsQuery

      public GetFolderAndContentsQuery(String folderId, boolean isUUID, FormatCode[] formatCodes, ConfidentialityCode[] confidentialityCodes, String homeCommunityId)
      Constructor that allows for the addition of a homeCommunityId to the query to support the XCA (Cross Community Access) profile extension of this query.
      Parameters:
      folderId - id of the folder (either uniqueId or entryUUID) (required)
      isUUID - set to true if folderID is the entryUUID (internal registry identifier) of the folder and set to false if it is the uniqueID (external to registry) of the folder. In most user cases, this should be set to false
      formatCodes - array of formatCodes to query for (can be null)
      confidentialityCodes - array of confidentiality codes to query for (can be null)
      homeCommunityId - this is the id of the home community as specified by the XCA profile. Value may be null or empty, in which case it is not added to the query.

    • GetFolderAndContentsQuery

      public GetFolderAndContentsQuery(String folderId, boolean isUUID, FormatCode[] formatCodes, ConfidentialityCode[] confidentialityCodes, String homeCommunityId, org.openehealth.ipf.commons.ihe.xds.core.metadata.DocumentEntryType objectType)
      Constructor that allows for the addition of a homeCommunityId to the query to support the XCA profile extension of this query.
      Parameters:
      folderId - id of the folder (either uniqueId or entryUUID) (required)
      isUUID - set to true if folderID is the entryUUID (internal registry identifier) of the folder and set to false if it is the uniqueID (external to registry) of the folder. In most user cases, this should be set to false
      formatCodes - array of formatCodes to query for (can be null)
      confidentialityCodes - array of confidentiality codes to query for (can be null)
      homeCommunityId - this is the id of the home community as specified by the XCA profile. Value may be null or empty, in which case it is not added to the query.
      objectType - for the OnDemand document feature. Tells whether you want static docs, on demand docs, or both

  • Method Details

    • addConfidentialityCodes

      public void addConfidentialityCodes(ConfidentialityCode[] confidentialityCodes)
      Adds an additional disjunctive clause of confidentiality codes to the query. Per IHE 2008-2009 ITI CP 228, codes with in the parameter will be interpreted with OR semantics. The resultant disjunctive clause will be AND-ed together with any confidentialityCode clauses previously added. Calling this method sequentially will result in the AND-ing of multiple clauses.
      Parameters:
      confidentialityCodes - array of confidentialityCodes, interpreted as a disjunctive clause in which each confidentialityCodes[i] will be a literal of that clause, to add to the query.

    • getIpfQuery

      public org.openehealth.ipf.commons.ihe.xds.core.requests.query.StoredQuery getIpfQuery()
      Description copied from class: AbstractStoredQuery
      Gets the IPF StoredQuery object, which is being wrapped by this class
      Specified by:
      getIpfQuery in interface StoredQueryInterface
      Overrides:
      getIpfQuery in class AbstractStoredQuery
      Returns:
      the IPF StoredQuery