2 * CitationAuthorityClient.java
4 * This document is a part of the source code and related artifacts for
5 * CollectionSpace, an open source collections management system for museums and
6 * related institutions:
8 * http://www.collectionspace.org http://wiki.collectionspace.org
10 * Copyright © 2009 University of California, Berkeley
12 * Licensed under the Educational Community License (ECL), Version 2.0. You may
13 * not use this file except in compliance with this License.
15 * You may obtain a copy of the ECL 2.0 License at
16 * https://source.collectionspace.org/collection-space/LICENSE.txt
18 package org.collectionspace.services.client;
20 import org.collectionspace.services.citation.CitationauthoritiesCommon;
21 import org.collectionspace.services.citation.CitationsCommon;
24 * The Class CitationAuthorityClient.
26 public class CitationAuthorityClient extends AuthorityClientImpl<CitationauthoritiesCommon, CitationsCommon, CitationAuthorityProxy> {
28 public static final String SERVICE_NAME = "citationauthorities";
29 public static final String SERVICE_PATH_COMPONENT = SERVICE_NAME;
30 public static final String SERVICE_PATH = "/" + SERVICE_PATH_COMPONENT;
31 public static final String SERVICE_PAYLOAD_NAME = SERVICE_NAME;
32 public static final String TERM_INFO_GROUP_XPATH_BASE = "citationTermGroupList";
36 public static final String SERVICE_ITEM_NAME = "citations";
37 public static final String SERVICE_ITEM_PAYLOAD_NAME = SERVICE_ITEM_NAME;
39 // Payload Part/Schema part names
41 public static final String SERVICE_COMMON_PART_NAME = SERVICE_NAME
42 + PART_LABEL_SEPARATOR + PART_COMMON_LABEL;
43 public static final String SERVICE_ITEM_COMMON_PART_NAME = SERVICE_ITEM_NAME
44 + PART_LABEL_SEPARATOR + PART_COMMON_LABEL;
49 public CitationAuthorityClient() throws Exception {
53 public CitationAuthorityClient(String clientPropertiesFilename) throws Exception {
54 super(clientPropertiesFilename);
58 public String getServiceName() {
63 public String getServicePathComponent() {
64 return SERVICE_PATH_COMPONENT;
68 public String getItemCommonPartName() {
69 return getCommonPartName(SERVICE_ITEM_PAYLOAD_NAME);
72 @Deprecated // Use getItemCommonPartName() instead
73 public String getCommonPartItemName() {
74 return getCommonPartName(SERVICE_ITEM_PAYLOAD_NAME);
78 public Class<CitationAuthorityProxy> getProxyClass() {
79 return CitationAuthorityProxy.class;
83 public String getInAuthority(CitationsCommon item) {
84 return item.getInAuthority();
88 public void setInAuthority(CitationsCommon item, String inAuthorityCsid) {
89 item.setInAuthority(inAuthorityCsid);
93 public String createAuthorityInstance(String shortIdentifier, String displayName) {
94 PoxPayloadOut poxPayloadOut = CitationAuthorityClientUtils.createCitationAuthorityInstance(displayName, shortIdentifier, SERVICE_COMMON_PART_NAME);
95 return poxPayloadOut.asXML();
99 public String createAuthorityItemInstance(String shortIdentifier, String displayName) {
100 // TODO Auto-generated method stub