nesstar.api.common
Class EGMSResource

java.lang.Object
  extended by java.util.Observable
      extended by nesstar.rdf.RDFObject
          extended by nesstar.api.common.Resource
              extended by nesstar.api.common.DCResource
                  extended by nesstar.api.common.EGMSResource
All Implemented Interfaces:
Comparable, RDFObj
Direct Known Subclasses:
EGMSResource2

public class EGMSResource
extends DCResource


Field Summary
static String CLASS_ID
           
 
Fields inherited from class nesstar.rdf.RDFObject
COLSEP, IS_GETTER, IS_PART, IS_PART_OF, WRITE_OP
 
Constructor Summary
EGMSResource(RDFDB db, URL id)
          Create an object with the indicated id in the indicated db
 
Method Summary
 void clear()
          Clear all properties of this object
 Bookmark Delete()
           Delete an isolated EGMResource.
 void Delete(BasicExecutorLog log)
           Delete an isolated EGMResource.
 String get_abstractText()
           
 String get_accessability()
           
 String get_accessibility()
           
 String get_addressee()
           
 String get_aggregation()
           
 String get_alternativeTitle()
           
 String get_audience()
           
 String get_authorisingStatute()
           
 String get_autoRemoveDate()
           
 String get_beginningDate()
           
 String get_bibliographicCitation()
           
 String get_category()
           
 String get_conformsTo()
           
 String get_copyright()
           
 String get_currentLocation()
           
 String get_custodian()
           
 String get_cutOffDate()
           
 String get_dataProtectionExemptCategory()
           
 String get_dateAccepted()
           
 String get_dateAquired()
           
 String get_dateAvailable()
           
 String get_dateCapturePeriod()
           
 String get_dateClosed()
           
 String get_dateCopyrighted()
           
 String get_dateCreated()
           
 String get_dateDeclared()
           
 String get_dateIssued()
           
 String get_dateModified()
           
 String get_dateNextVersionDue()
           
 String get_dateOfLastReview()
           
 String get_datesModified()
           
 String get_dateSubmitted()
           
 String get_dateValid()
           
 String get_descriptor()
           
 String get_digitalSignature()
           
 String get_disclosabilityToDPADataSubject()
           
 String get_disposal()
           
 String get_disposalAction()
           
 String get_disposalAuthorisedBy()
           
 String get_disposalComment()
           
 String get_disposalConditions()
           
 String get_disposalDate()
           
 String get_disposalExportDestination()
           
 String get_disposalExportStatus()
           
 String get_disposalReview()
           
 String get_disposalReviewDetails()
           
 String get_disposalReviewerDetails()
           
 String get_disposalScheduleID()
           
 String get_disposalTimePeriod()
           
 String get_dPADataSubjectAccessExemption()
           
 String get_educationLevel()
           
 String get_eIRDisclosabilityIndicator()
           
 String get_eIRExemption()
           
 String get_endDate()
           
 String get_endDateOfCapture()
           
 RDFRef get_event()
           
 String get_extent()
           
 String get_fileplanID()
           
 String get_fOIDisclosabilityIndicator()
           
 String get_fOIExemption()
           
 String get_fOIReleaseDate()
           
 String get_fOIReleaseDetails()
           
 String get_groupAccess()
           
 String get_hasFormat()
           
 String get_hasPart()
           
 String get_hasVersion()
           
 String get_homeLocation()
           
 String get_individualUserAccessList()
           
 String get_isDefinedBy()
           
 String get_isFormatOf()
           
 String get_isPartOf()
           
 String get_isReferencedBy()
           
 String get_isReplacedBy()
           
 String get_isRequiredBy()
           
 String get_isVersionOf()
           
 String get_keyword()
           
 String get_lastFOIDisclosabilityReview()
           
 String get_location()
           
 String get_mandate()
           
 String get_mediator()
           
 String get_medium()
           
 String get_notes()
           
 String get_originalFormat()
           
 RDFRef get_person()
           
 String get_personalDataAquisitionPurpose()
           
 String get_postcode()
           
 String get_preservation()
           
 String get_previousProtectiveMarking()
           
 String get_processIdentifier()
           
 String get_programme()
           
 String get_project()
           
 String get_protectiveMarking()
           
 String get_protectiveMarkingChangeDate()
           
 String get_protectiveMarkingExpiryDate()
           
 String get_providesDefinitionOf()
           
 String get_reasonForRedaction()
           
 String get_redaction()
           
 String get_replaces()
           
 String get_requires()
           
 String get_resourceReferences()
           
 String get_sequenceNum()
           
 String get_spatial()
           
 String get_spatialLocation()
           
 String get_startDateOfCapture()
           
 String get_status()
           
 String get_statusOfStartDateOfCapture()
           
 RDFRef get_study()
           
 String get_systemID()
           
 String get_tableOfContents()
           
 String get_temporal()
           
 String get_updatingFrequency()
           
 String get_uri()
           
 String getAbstractText()
           Refinement of description
 String getAccessability()
          Deprecated. replaced by accessibility
 String getAccessibility()
           
 String[] getAddressee()
           The person (or persons) to whom the resource was addressed.
 String getAddresseeAsString()
           
 String getAggregation()
           The resource’s level or position in a hierarchy.
static Vector getAllInstances()
           
static Vector getAllInstances(RDFDB db)
           
 String[] getAlternativeTitle()
           Refinement of title
 String getAlternativeTitleAsString()
           
 String getAudience()
           A category of user for whom the resource is intended.
 String getAuthorisingStatute()
           Refinement of mandate
 Date getAutoRemoveDate()
           Refinement of disposal
 Date getBeginningDate()
           Refinement of coverage.temporal
 String getBibliographicCitation()
           Refinement of identifier
 String[] getCategory()
           Refinement of subject
 String getCategoryAsString()
           
 String getComment()
           An account of the content of the resource.
 String[] getConformsTo()
           Refinement of relation
 String getConformsToAsString()
           
 String[] getCopyright()
           Refinement of rights
 String getCopyrightAsString()
           
 String getCurrentLocation()
           Refinement of location
 String[] getCustodian()
           Refinement of rights
 String getCustodianAsString()
           
 Date getCutOffDate()
           Refinement of date
 String[] getDataProtectionExemptCategory()
           Refinement of mandate
 String getDataProtectionExemptCategoryAsString()
           
 Date getDateAccepted()
           Refinement of date
 Date getDateAquired()
           Incorrectly spelled property.
 Date getDateAvailable()
           Refinement of date
 String[] getDateCapturePeriod()
           Refinement of coverage.temporal
 String getDateCapturePeriodAsString()
           
 Date getDateClosed()
           Refinement of date
 Date getDateCopyrighted()
           Refinement of date
 Date getDateCreated()
           Refinement of date
 Date getDateDeclared()
           Refinement of date
 Date getDateIssued()
           Refinement of date
 Date getDateModified()
           Refinement of date
 Date getDateNextVersionDue()
           Refinement of date
 Date getDateOfLastReview()
           Refinement of disposal
 String[] getDatesModified()
           An array of modification dates (currently stored as Strings as Data arrays are not yet supported).
 String getDatesModifiedAsString()
           
 Date getDateSubmitted()
           Refinement of date
 Date getDateValid()
           Refinement of date
 String getDescriptor()
           Refinement of rights
static FeatureDescriptor getDescriptor(String featureName)
          get the descriptor for a feature of the class, either method or attribute Note: the methods' feature are still not implemented
 String getDigitalSignature()
           For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf
 String getDisclosabilityToDPADataSubject()
           Refinement of rights
 String getDisposal()
           The retention and disposal instructions for the resource.
 String getDisposalAction()
           Refinement of disposal
 String[] getDisposalAuthorisedBy()
           Refinement of disposal
 String getDisposalAuthorisedByAsString()
           
 String getDisposalComment()
           Refinement of disposal
 String getDisposalConditions()
           Refinement of disposal
 Date getDisposalDate()
           Refinement of disposal
 String getDisposalExportDestination()
           Refinement of disposal
 String getDisposalExportStatus()
           Refinement of disposal
 String getDisposalReview()
           Refinement of disposal
 String getDisposalReviewDetails()
           Refinement of disposal
 String[] getDisposalReviewerDetails()
           Refinement of disposal
 String getDisposalReviewerDetailsAsString()
           
 String getDisposalScheduleID()
           Refinement of disposal
 String getDisposalTimePeriod()
           Refinement of disposal
 String getDPADataSubjectAccessExemption()
           Refinement of rights
 String getEducationLevel()
           Refinement of audience
 String getEIRDisclosabilityIndicator()
           Refinement of rights
 String getEIRExemption()
           Refinement of rights
 Date getEndDate()
           Refinement of coverage.temporal
 Date getEndDateOfCapture()
           Refinement of coverage.temporal
 Event getEvent()
           
 String getExtent()
           Refinement of format
 String getFileplanID()
           Refinement of identifier
 String getFOIDisclosabilityIndicator()
           Refinement of rights
 String getFOIExemption()
           Refinement of rights
 Date getFOIReleaseDate()
           Refinement of rights
 String[] getFOIReleaseDetails()
           Refinement of rights
 String getFOIReleaseDetailsAsString()
           
static Collection getGetterMethods()
           
 String[] getGroupAccess()
           Refinement of rights
 String getGroupAccessAsString()
           
 String[] getHasFormat()
           Refinement of relation
 String getHasFormatAsString()
           
 String[] getHasPart()
           Refinement of relation
 String getHasPartAsString()
           
 String[] getHasVersion()
           Refinement of relation
 String getHasVersionAsString()
           
 String getHomeLocation()
           Refinement of location
 String[] getIndividualUserAccessList()
           Refinement of rights
 String getIndividualUserAccessListAsString()
           
static Resource getInstance(RDFDB db, URL id)
          If an object of type EGMSResource with the indicated id exists in the db returns it otherwise create a new object in the db and returns it
static Resource getInstance(String rdf)
           
 String[] getIsDefinedBy()
           Refinement of relation
 String getIsDefinedByAsString()
           
 String[] getIsFormatOf()
           Refinement of relation
 String getIsFormatOfAsString()
           
 String[] getIsPartOf()
           Refinement of relation
 String getIsPartOfAsString()
           
 String[] getIsReferencedBy()
           Refinement of relation
 String getIsReferencedByAsString()
           
 String[] getIsReplacedBy()
           Refinement of relation
 String getIsReplacedByAsString()
           
 String[] getIsRequiredBy()
           Refinement of relation
 String getIsRequiredByAsString()
           
 String getIsVersionOf()
           Refinement of relation
 String[] getKeyword()
           Refinement of subject
 String getKeywordAsString()
           
 String getLastFOIDisclosabilityReview()
           Refinement of rights
 String getLocation()
           The physical location of the resource.
 String getMandate()
           Legislative or other mandate under which the resource was produced.
 String getMediator()
           Refinement of audience
 String getMedium()
           Refinement of format
 String getNotes()
           Non e-GMS field.
 String getOriginalFormat()
           Refinement of preservation
static Collection getPartsDescriptor()
           
 Person getPerson()
           
 String[] getPersonalDataAquisitionPurpose()
           Refinement of mandate
 String getPersonalDataAquisitionPurposeAsString()
           
 String[] getPostcode()
           Refinement of coverage.spatial
 String getPostcodeAsString()
           
 String getPreservation()
           Information to support the long-term preservation of a resource.
 String[] getPreviousProtectiveMarking()
           Refinement of rights
 String getPreviousProtectiveMarkingAsString()
           
 String[] getProcessIdentifier()
           Refinement of subject
 String getProcessIdentifierAsString()
           
 String[] getProgramme()
           Refinement of subject
 String getProgrammeAsString()
           
 String[] getProject()
           Refinement of subject
 String getProjectAsString()
           
 String getProtectiveMarking()
           Refinement of rights
 Date getProtectiveMarkingChangeDate()
           Refinement of rights
 Date getProtectiveMarkingExpiryDate()
           Refinement of rights
 String getProvidesDefinitionOf()
           Refinement of relation
 String getReasonForRedaction()
           Refinement of relation
 String getRedaction()
           Refinement of relation
 String[] getReplaces()
           Refinement of relation
 String getReplacesAsString()
           
 String[] getRequires()
           Refinement of relation
 String getRequiresAsString()
           
 String[] getResourceReferences()
           Refinement of relation
 String getResourceReferencesAsString()
           
 String getSequenceNum()
           Refinement of relation
 String[] getSpatial()
           Refinement of coverage
 String getSpatialAsString()
           
 String[] getSpatialLocation()
           Refinement of coverage.spatial
 String getSpatialLocationAsString()
           
 Date getStartDateOfCapture()
           Refinement of coverage.temporal
 String getStatus()
           The position or state of the resource.
 String getStatusOfStartDateOfCapture()
           Refinement of coverage.temporal
 Study2 getStudy()
           
 String getSystemID()
           Refinement of identifier
 String getTableOfContents()
           Refinement of description
 String[] getTemporal()
           Refinement of coverage
 String getTemporalAsString()
           
 String getUpdatingFrequency()
           Refinement of date
 String getUri()
          
 void initialised()
          Notify that the object has been created and its properties setup for the first time.
static void listenForNewObj(NewObjListener listener)
          Register to be notified when new objects are added.
static Resource newInstance(RDFDB db)
          Create a new object of this type with a locally unique id and returns it
static Resource retrieve(URL id)
          If an object of type EGMSResource with the indicated id has already being retrieved from the network returns it otherwise retrieve it together with its class information (methods, properties, etc.)
 void set_abstractText(String abstractText)
           
 void set_accessability(String accessability)
           
 void set_accessibility(String accessibility)
           
 void set_addressee(String addressee)
           
 void set_aggregation(String aggregation)
           
 void set_alternativeTitle(String alternativeTitle)
           
 void set_audience(String audience)
           
 void set_authorisingStatute(String authorisingStatute)
           
 void set_autoRemoveDate(String autoRemoveDate)
           
 void set_beginningDate(String beginningDate)
           
 void set_bibliographicCitation(String bibliographicCitation)
           
 void set_category(String category)
           
 void set_conformsTo(String conformsTo)
           
 void set_copyright(String copyright)
           
 void set_currentLocation(String currentLocation)
           
 void set_custodian(String custodian)
           
 void set_cutOffDate(String cutOffDate)
           
 void set_dataProtectionExemptCategory(String dataProtectionExemptCategory)
           
 void set_dateAccepted(String dateAccepted)
           
 void set_dateAquired(String dateAquired)
           
 void set_dateAvailable(String dateAvailable)
           
 void set_dateCapturePeriod(String dateCapturePeriod)
           
 void set_dateClosed(String dateClosed)
           
 void set_dateCopyrighted(String dateCopyrighted)
           
 void set_dateCreated(String dateCreated)
           
 void set_dateDeclared(String dateDeclared)
           
 void set_dateIssued(String dateIssued)
           
 void set_dateModified(String dateModified)
           
 void set_dateNextVersionDue(String dateNextVersionDue)
           
 void set_dateOfLastReview(String dateOfLastReview)
           
 void set_datesModified(String datesModified)
           
 void set_dateSubmitted(String dateSubmitted)
           
 void set_dateValid(String dateValid)
           
 void set_descriptor(String descriptor)
           
 void set_digitalSignature(String digitalSignature)
           
 void set_disclosabilityToDPADataSubject(String disclosabilityToDPADataSubject)
           
 void set_disposal(String disposal)
           
 void set_disposalAction(String disposalAction)
           
 void set_disposalAuthorisedBy(String disposalAuthorisedBy)
           
 void set_disposalComment(String disposalComment)
           
 void set_disposalConditions(String disposalConditions)
           
 void set_disposalDate(String disposalDate)
           
 void set_disposalExportDestination(String disposalExportDestination)
           
 void set_disposalExportStatus(String disposalExportStatus)
           
 void set_disposalReview(String disposalReview)
           
 void set_disposalReviewDetails(String disposalReviewDetails)
           
 void set_disposalReviewerDetails(String disposalReviewerDetails)
           
 void set_disposalScheduleID(String disposalScheduleID)
           
 void set_disposalTimePeriod(String disposalTimePeriod)
           
 void set_dPADataSubjectAccessExemption(String dPADataSubjectAccessExemption)
           
 void set_educationLevel(String educationLevel)
           
 void set_eIRDisclosabilityIndicator(String eIRDisclosabilityIndicator)
           
 void set_eIRExemption(String eIRExemption)
           
 void set_endDate(String endDate)
           
 void set_endDateOfCapture(String endDateOfCapture)
           
 void set_event(RDFRef event)
           
 void set_extent(String extent)
           
 void set_fileplanID(String fileplanID)
           
 void set_fOIDisclosabilityIndicator(String fOIDisclosabilityIndicator)
           
 void set_fOIExemption(String fOIExemption)
           
 void set_fOIReleaseDate(String fOIReleaseDate)
           
 void set_fOIReleaseDetails(String fOIReleaseDetails)
           
 void set_groupAccess(String groupAccess)
           
 void set_hasFormat(String hasFormat)
           
 void set_hasPart(String hasPart)
           
 void set_hasVersion(String hasVersion)
           
 void set_homeLocation(String homeLocation)
           
 void set_individualUserAccessList(String individualUserAccessList)
           
 void set_isDefinedBy(String isDefinedBy)
           
 void set_isFormatOf(String isFormatOf)
           
 void set_isPartOf(String isPartOf)
           
 void set_isReferencedBy(String isReferencedBy)
           
 void set_isReplacedBy(String isReplacedBy)
           
 void set_isRequiredBy(String isRequiredBy)
           
 void set_isVersionOf(String isVersionOf)
           
 void set_keyword(String keyword)
           
 void set_lastFOIDisclosabilityReview(String lastFOIDisclosabilityReview)
           
 void set_location(String location)
           
 void set_mandate(String mandate)
           
 void set_mediator(String mediator)
           
 void set_medium(String medium)
           
 void set_notes(String notes)
           
 void set_originalFormat(String originalFormat)
           
 void set_person(RDFRef person)
           
 void set_personalDataAquisitionPurpose(String personalDataAquisitionPurpose)
           
 void set_postcode(String postcode)
           
 void set_preservation(String preservation)
           
 void set_previousProtectiveMarking(String previousProtectiveMarking)
           
 void set_processIdentifier(String processIdentifier)
           
 void set_programme(String programme)
           
 void set_project(String project)
           
 void set_protectiveMarking(String protectiveMarking)
           
 void set_protectiveMarkingChangeDate(String protectiveMarkingChangeDate)
           
 void set_protectiveMarkingExpiryDate(String protectiveMarkingExpiryDate)
           
 void set_providesDefinitionOf(String providesDefinitionOf)
           
 void set_reasonForRedaction(String reasonForRedaction)
           
 void set_redaction(String redaction)
           
 void set_replaces(String replaces)
           
 void set_requires(String requires)
           
 void set_resourceReferences(String resourceReferences)
           
 void set_sequenceNum(String sequenceNum)
           
 void set_spatial(String spatial)
           
 void set_spatialLocation(String spatialLocation)
           
 void set_startDateOfCapture(String startDateOfCapture)
           
 void set_status(String status)
           
 void set_statusOfStartDateOfCapture(String statusOfStartDateOfCapture)
           
 void set_study(RDFRef study)
           
 void set_systemID(String systemID)
           
 void set_tableOfContents(String tableOfContents)
           
 void set_temporal(String temporal)
           
 void set_updatingFrequency(String updatingFrequency)
           
 void set_uri(String uri)
           
 void setAbstractText(String abstractText)
           Refinement of description
 void setAccessability(String accessability)
          Deprecated. replaced by accessibility
 void setAccessibility(String accessibility)
           
 void setAddressee(String[] addressee)
           The person (or persons) to whom the resource was addressed.
 void setAggregation(String aggregation)
           The resource’s level or position in a hierarchy.
 void setAlternativeTitle(String[] alternativeTitle)
           Refinement of title
 void setAudience(String audience)
           A category of user for whom the resource is intended.
 void setAuthorisingStatute(String authorisingStatute)
           Refinement of mandate
 void setAutoRemoveDate(Date autoRemoveDate)
           Refinement of disposal
 void setBeginningDate(Date beginningDate)
           Refinement of coverage.temporal
 void setBibliographicCitation(String bibliographicCitation)
           Refinement of identifier
 void setCategory(String[] category)
           Refinement of subject
 void setConformsTo(String[] conformsTo)
           Refinement of relation
 void setCopyright(String[] copyright)
           Refinement of rights
 void setCurrentLocation(String currentLocation)
           Refinement of location
 void setCustodian(String[] custodian)
           Refinement of rights
 void setCutOffDate(Date cutOffDate)
           Refinement of date
 void setDataProtectionExemptCategory(String[] dataProtectionExemptCategory)
           Refinement of mandate
 void setDateAccepted(Date dateAccepted)
           Refinement of date
 void setDateAquired(Date dateAquired)
           Incorrectly spelled property.
 void setDateAvailable(Date dateAvailable)
           Refinement of date
 void setDateCapturePeriod(String[] dateCapturePeriod)
           Refinement of coverage.temporal
 void setDateClosed(Date dateClosed)
           Refinement of date
 void setDateCopyrighted(Date dateCopyrighted)
           Refinement of date
 void setDateCreated(Date dateCreated)
           Refinement of date
 void setDateDeclared(Date dateDeclared)
           Refinement of date
 void setDateIssued(Date dateIssued)
           Refinement of date
 void setDateModified(Date dateModified)
           Refinement of date
 void setDateNextVersionDue(Date dateNextVersionDue)
           Refinement of date
 void setDateOfLastReview(Date dateOfLastReview)
           Refinement of disposal
 void setDatesModified(String[] datesModified)
           An array of modification dates (currently stored as Strings as Data arrays are not yet supported).
 void setDateSubmitted(Date dateSubmitted)
           Refinement of date
 void setDateValid(Date dateValid)
           Refinement of date
 void setDescriptor(String descriptor)
           Refinement of rights
 void setDigitalSignature(String digitalSignature)
           For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf
 void setDisclosabilityToDPADataSubject(String disclosabilityToDPADataSubject)
           Refinement of rights
 void setDisposal(String disposal)
           The retention and disposal instructions for the resource.
 void setDisposalAction(String disposalAction)
           Refinement of disposal
 void setDisposalAuthorisedBy(String[] disposalAuthorisedBy)
           Refinement of disposal
 void setDisposalComment(String disposalComment)
           Refinement of disposal
 void setDisposalConditions(String disposalConditions)
           Refinement of disposal
 void setDisposalDate(Date disposalDate)
           Refinement of disposal
 void setDisposalExportDestination(String disposalExportDestination)
           Refinement of disposal
 void setDisposalExportStatus(String disposalExportStatus)
           Refinement of disposal
 void setDisposalReview(String disposalReview)
           Refinement of disposal
 void setDisposalReviewDetails(String disposalReviewDetails)
           Refinement of disposal
 void setDisposalReviewerDetails(String[] disposalReviewerDetails)
           Refinement of disposal
 void setDisposalScheduleID(String disposalScheduleID)
           Refinement of disposal
 void setDisposalTimePeriod(String disposalTimePeriod)
           Refinement of disposal
 void setDPADataSubjectAccessExemption(String dPADataSubjectAccessExemption)
           Refinement of rights
 void setEducationLevel(String educationLevel)
           Refinement of audience
 void setEIRDisclosabilityIndicator(String eIRDisclosabilityIndicator)
           Refinement of rights
 void setEIRExemption(String eIRExemption)
           Refinement of rights
 void setEndDate(Date endDate)
           Refinement of coverage.temporal
 void setEndDateOfCapture(Date endDateOfCapture)
           Refinement of coverage.temporal
 void setEvent(Event event)
           
 void setExtent(String extent)
           Refinement of format
 void setFileplanID(String fileplanID)
           Refinement of identifier
 void setFOIDisclosabilityIndicator(String fOIDisclosabilityIndicator)
           Refinement of rights
 void setFOIExemption(String fOIExemption)
           Refinement of rights
 void setFOIReleaseDate(Date fOIReleaseDate)
           Refinement of rights
 void setFOIReleaseDetails(String[] fOIReleaseDetails)
           Refinement of rights
 void setGroupAccess(String[] groupAccess)
           Refinement of rights
 void setHasFormat(String[] hasFormat)
           Refinement of relation
 void setHasPart(String[] hasPart)
           Refinement of relation
 void setHasVersion(String[] hasVersion)
           Refinement of relation
 void setHomeLocation(String homeLocation)
           Refinement of location
 void setIndividualUserAccessList(String[] individualUserAccessList)
           Refinement of rights
 void setIsDefinedBy(String[] isDefinedBy)
           Refinement of relation
 void setIsFormatOf(String[] isFormatOf)
           Refinement of relation
 void setIsPartOf(String[] isPartOf)
           Refinement of relation
 void setIsReferencedBy(String[] isReferencedBy)
           Refinement of relation
 void setIsReplacedBy(String[] isReplacedBy)
           Refinement of relation
 void setIsRequiredBy(String[] isRequiredBy)
           Refinement of relation
 void setIsVersionOf(String isVersionOf)
           Refinement of relation
 void setKeyword(String[] keyword)
           Refinement of subject
 void setLastFOIDisclosabilityReview(String lastFOIDisclosabilityReview)
           Refinement of rights
 void setLocation(String location)
           The physical location of the resource.
 void setMandate(String mandate)
           Legislative or other mandate under which the resource was produced.
 void setMediator(String mediator)
           Refinement of audience
 void setMedium(String medium)
           Refinement of format
 void setNotes(String notes)
           Non e-GMS field.
 void setOriginalFormat(String originalFormat)
           Refinement of preservation
 void setPerson(Person person)
           
 void setPersonalDataAquisitionPurpose(String[] personalDataAquisitionPurpose)
           Refinement of mandate
 void setPostcode(String[] postcode)
           Refinement of coverage.spatial
 void setPreservation(String preservation)
           Information to support the long-term preservation of a resource.
 void setPreviousProtectiveMarking(String[] previousProtectiveMarking)
           Refinement of rights
 void setProcessIdentifier(String[] processIdentifier)
           Refinement of subject
 void setProgramme(String[] programme)
           Refinement of subject
 void setProject(String[] project)
           Refinement of subject
 void setProtectiveMarking(String protectiveMarking)
           Refinement of rights
 void setProtectiveMarkingChangeDate(Date protectiveMarkingChangeDate)
           Refinement of rights
 void setProtectiveMarkingExpiryDate(Date protectiveMarkingExpiryDate)
           Refinement of rights
 void setProvidesDefinitionOf(String providesDefinitionOf)
           Refinement of relation
 void setReasonForRedaction(String reasonForRedaction)
           Refinement of relation
 void setRedaction(String redaction)
           Refinement of relation
 void setReplaces(String[] replaces)
           Refinement of relation
 void setRequires(String[] requires)
           Refinement of relation
 void setResourceReferences(String[] resourceReferences)
           Refinement of relation
 void setSequenceNum(String sequenceNum)
           Refinement of relation
 void setSpatial(String[] spatial)
           Refinement of coverage
 void setSpatialLocation(String[] spatialLocation)
           Refinement of coverage.spatial
 void setStartDateOfCapture(Date startDateOfCapture)
           Refinement of coverage.temporal
 void setStatus(String status)
           The position or state of the resource.
 void setStatusOfStartDateOfCapture(String statusOfStartDateOfCapture)
           Refinement of coverage.temporal
 void setStudy(Study2 study)
           
 void setSystemID(String systemID)
           Refinement of identifier
 void setTableOfContents(String tableOfContents)
           Refinement of description
 void setTemporal(String[] temporal)
           Refinement of coverage
 void setUpdatingFrequency(String updatingFrequency)
           Refinement of date
 void setUri(String uri)
          
 
Methods inherited from class nesstar.api.common.DCResource
get_contributor, get_coverage, get_creator, get_format, get_identifier, get_language, get_publisher, get_relation, get_resourceDate, get_resourceType, get_rights, get_source, get_subject, getContributor, getContributorAsString, getCoverage, getCoverageAsString, getCreator, getCreatorAsString, getFormat, getIdentifier, getLanguage, getLanguageAsString, getPublisher, getPublisherAsString, getRelation, getRelationAsString, getResourceDate, getResourceDateAsString, getResourceType, getRights, getRightsAsString, getSource, getSourceAsString, getSubject, getSubjectAsString, set_contributor, set_coverage, set_creator, set_format, set_identifier, set_language, set_publisher, set_relation, set_resourceDate, set_resourceType, set_rights, set_source, set_subject, setContributor, setCoverage, setCreator, setFormat, setIdentifier, setLanguage, setPublisher, setRelation, setResourceDate, setResourceType, setRights, setSource, setSubject
 
Methods inherited from class nesstar.rdf.RDFObject
AddProperty, AddStringProperty, chkFinal, compareTo, dbg, equals, err, err, get_comment, get_creationDate, get_label, get, getAccessCondition, getBinding, getBindings, getBookmarkLabel, getCollectionURL, getCreationDate, getDB, getDescriptor, getDomain, getID, getInitialisedProperties, getInternalID, getLabel, getLastClear, getPartsDescriptor, getPartsDescriptor, getPath, getProperties, GetProperties, GetProperty, GetPropertyStatement, GetPropertyStatements, getRange, getRangeType, getRef, getRef, getServer, getShortId, getShortID, getStatementHome, GetStringProperties, GetStringProperty, getTimeoutInSecs, getType, init, init, isComplete, isLocal, isMeta, isStale, loaded, neededCollectionReload, neededReload, neededReload, neededReload, neededReload, needsReload, reload, remove, set_comment, set_complete, set_creationDate, set_label, set, setComment, setComplete, setCreationDate, setDB, setHardOrSoft, setID, setLabel, setLastClear, SetProperty, setServer, SetStringProperty, setTimeoutInSecs, setTimestamp, setType, setTypeID, stale, toRDF, toRDFWrapped, toString, update
 
Methods inherited from class java.util.Observable
addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CLASS_ID

public static String CLASS_ID
Constructor Detail

EGMSResource

public EGMSResource(RDFDB db,
                    URL id)
             throws Exception
Create an object with the indicated id in the indicated db

Parameters:
db - the db where the object is to be created
id - the id of the object to create
Throws:
Exception
Method Detail

set_study

public void set_study(RDFRef study)
Parameters:
study -

setStudy

public void setStudy(Study2 study)
              throws Exception
Parameters:
study -
Throws:
Exception

set_person

public void set_person(RDFRef person)
Parameters:
person -

setPerson

public void setPerson(Person person)
               throws Exception
Parameters:
person -
Throws:
Exception

set_event

public void set_event(RDFRef event)
Parameters:
event -

setEvent

public void setEvent(Event event)
              throws Exception
Parameters:
event -
Throws:
Exception

setUri

public void setUri(String uri)

Parameters:
uri -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><othrStdyMat><relMat><citation><holdings URI>, <codeBook><stdyDscr><othrStdyMat><relStdy><citation><holdings URI>, <codeBook><stdyDscr><othrStdyMat><relPubl><citation><holdings URI>, <codeBook><stdyDscr><othrStdyMat><othRefs><citation><holdings URI>

set_uri

public void set_uri(String uri)
Parameters:
uri -

setNotes

public void setNotes(String notes)

Non e-GMS field. Used for citation.notes in relatedMaterials

Parameters:
notes -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><othrStdyMat><relMat><citation><notes>, <codeBook><stdyDscr><othrStdyMat><relStdy><citation><notes>, <codeBook><stdyDscr><othrStdyMat><relPubl><citation><notes>, <codeBook><stdyDscr><othrStdyMat><othRefs><citation><notes>

set_notes

public void set_notes(String notes)
Parameters:
notes -

setAccessability

public void setAccessability(String accessability)
Deprecated. replaced by accessibility

Indicates the resource’s availability and usability to specific groups.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
accessability -

set_accessability

public void set_accessability(String accessability)
Parameters:
accessability -

setAddressee

public void setAddressee(String[] addressee)

The person (or persons) to whom the resource was addressed.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
addressee -

set_addressee

public void set_addressee(String addressee)
Parameters:
addressee -

setAggregation

public void setAggregation(String aggregation)

The resource’s level or position in a hierarchy.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
aggregation -

set_aggregation

public void set_aggregation(String aggregation)
Parameters:
aggregation -

setAudience

public void setAudience(String audience)

A category of user for whom the resource is intended.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
audience -

set_audience

public void set_audience(String audience)
Parameters:
audience -

setEducationLevel

public void setEducationLevel(String educationLevel)

Refinement of audience

A general statement describing the education or training context. Alternatively, a more specific statement of the location of the audience in terms of its progression through an education or training context.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
educationLevel -

set_educationLevel

public void set_educationLevel(String educationLevel)
Parameters:
educationLevel -

setMediator

public void setMediator(String mediator)

Refinement of audience

A class of entity that mediates access to the resource and for whom the resource is intended or useful.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
mediator -

set_mediator

public void set_mediator(String mediator)
Parameters:
mediator -

setTemporal

public void setTemporal(String[] temporal)

Refinement of coverage

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
temporal -

set_temporal

public void set_temporal(String temporal)
Parameters:
temporal -

setBeginningDate

public void setBeginningDate(Date beginningDate)

Refinement of coverage.temporal

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
beginningDate -

set_beginningDate

public void set_beginningDate(String beginningDate)
Parameters:
beginningDate -

setEndDate

public void setEndDate(Date endDate)

Refinement of coverage.temporal

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
endDate -

set_endDate

public void set_endDate(String endDate)
Parameters:
endDate -

setDateCapturePeriod

public void setDateCapturePeriod(String[] dateCapturePeriod)

Refinement of coverage.temporal

If the elements of this array are ranges the end periods should be stored in EGMSResource2.coverageSpatialDateCapturePeriodEnds.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
dateCapturePeriod -

set_dateCapturePeriod

public void set_dateCapturePeriod(String dateCapturePeriod)
Parameters:
dateCapturePeriod -

setStatusOfStartDateOfCapture

public void setStatusOfStartDateOfCapture(String statusOfStartDateOfCapture)

Refinement of coverage.temporal

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
statusOfStartDateOfCapture -

set_statusOfStartDateOfCapture

public void set_statusOfStartDateOfCapture(String statusOfStartDateOfCapture)
Parameters:
statusOfStartDateOfCapture -

setStartDateOfCapture

public void setStartDateOfCapture(Date startDateOfCapture)

Refinement of coverage.temporal

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
startDateOfCapture -

set_startDateOfCapture

public void set_startDateOfCapture(String startDateOfCapture)
Parameters:
startDateOfCapture -

setEndDateOfCapture

public void setEndDateOfCapture(Date endDateOfCapture)

Refinement of coverage.temporal

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
endDateOfCapture -

set_endDateOfCapture

public void set_endDateOfCapture(String endDateOfCapture)
Parameters:
endDateOfCapture -

setSpatial

public void setSpatial(String[] spatial)

Refinement of coverage

Note: it is preferable to avoid using this field and use postcode or spatialLocation instead.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
spatial -

set_spatial

public void set_spatial(String spatial)
Parameters:
spatial -

setPostcode

public void setPostcode(String[] postcode)

Refinement of coverage.spatial

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
postcode -

set_postcode

public void set_postcode(String postcode)
Parameters:
postcode -

setSpatialLocation

public void setSpatialLocation(String[] spatialLocation)

Refinement of coverage.spatial

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
spatialLocation -

set_spatialLocation

public void set_spatialLocation(String spatialLocation)
Parameters:
spatialLocation -

setDateAvailable

public void setDateAvailable(Date dateAvailable)

Refinement of date

Date that the resource will become or did become available.

If it is a range this field stores the initial date and EGMSResource2.dateAvailableEnd stores the end date.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
dateAvailable -

set_dateAvailable

public void set_dateAvailable(String dateAvailable)
Parameters:
dateAvailable -

setDateCreated

public void setDateCreated(Date dateCreated)

Refinement of date

Date of creation of the resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
dateCreated -

set_dateCreated

public void set_dateCreated(String dateCreated)
Parameters:
dateCreated -

setCutOffDate

public void setCutOffDate(Date cutOffDate)

Refinement of date

Date from which the resource should no longer be added to or modified.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
cutOffDate -

set_cutOffDate

public void set_cutOffDate(String cutOffDate)
Parameters:
cutOffDate -

setDateClosed

public void setDateClosed(Date dateClosed)

Refinement of date

Date which the capacity to store the resource as part of a collection was revoked.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
dateClosed -

set_dateClosed

public void set_dateClosed(String dateClosed)
Parameters:
dateClosed -

setDateAccepted

public void setDateAccepted(Date dateAccepted)

Refinement of date

Date of acceptance of the resource (e.g. of thesis by university department, of article by journal etc.).

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
dateAccepted -

set_dateAccepted

public void set_dateAccepted(String dateAccepted)
Parameters:
dateAccepted -

setDateCopyrighted

public void setDateCopyrighted(Date dateCopyrighted)

Refinement of date

Date of a statement of copyright. Use if date is different from date.created or if date.created is not given.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
dateCopyrighted -

set_dateCopyrighted

public void set_dateCopyrighted(String dateCopyrighted)
Parameters:
dateCopyrighted -

setDateSubmitted

public void setDateSubmitted(Date dateSubmitted)

Refinement of date

Date of submission of the resource (e.g. thesis, article etc.).

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
dateSubmitted -

set_dateSubmitted

public void set_dateSubmitted(String dateSubmitted)
Parameters:
dateSubmitted -

setDateDeclared

public void setDateDeclared(Date dateDeclared)

Refinement of date

Date on which the resource was declared, filed or stored.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
dateDeclared -

set_dateDeclared

public void set_dateDeclared(String dateDeclared)
Parameters:
dateDeclared -

setDateIssued

public void setDateIssued(Date dateIssued)

Refinement of date

Date of formal issuance (e.g. publication) of the resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
dateIssued -

set_dateIssued

public void set_dateIssued(String dateIssued)
Parameters:
dateIssued -

setDateModified

public void setDateModified(Date dateModified)

Refinement of date

Date on which the resource was changed.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
dateModified -

set_dateModified

public void set_dateModified(String dateModified)
Parameters:
dateModified -

setDateNextVersionDue

public void setDateNextVersionDue(Date dateNextVersionDue)

Refinement of date

Date on which the resource is due to be superseded.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
dateNextVersionDue -

set_dateNextVersionDue

public void set_dateNextVersionDue(String dateNextVersionDue)
Parameters:
dateNextVersionDue -

setUpdatingFrequency

public void setUpdatingFrequency(String updatingFrequency)

Refinement of date

How often the resource is updated.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
updatingFrequency -

set_updatingFrequency

public void set_updatingFrequency(String updatingFrequency)
Parameters:
updatingFrequency -

setDateValid

public void setDateValid(Date dateValid)

Refinement of date

The date of validity of a resource.

If it is a range this field stores the initial date and EGMSResource2.dateValidEnd stores the end date.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
dateValid -

set_dateValid

public void set_dateValid(String dateValid)
Parameters:
dateValid -

setAbstractText

public void setAbstractText(String abstractText)

Refinement of description

A summary of the content of the resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
abstractText -

set_abstractText

public void set_abstractText(String abstractText)
Parameters:
abstractText -

setTableOfContents

public void setTableOfContents(String tableOfContents)

Refinement of description

A list of sub-units of the content of the resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
tableOfContents -

set_tableOfContents

public void set_tableOfContents(String tableOfContents)
Parameters:
tableOfContents -

setDigitalSignature

public void setDigitalSignature(String digitalSignature)

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
digitalSignature -

set_digitalSignature

public void set_digitalSignature(String digitalSignature)
Parameters:
digitalSignature -

setDisposal

public void setDisposal(String disposal)

The retention and disposal instructions for the resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
disposal -

set_disposal

public void set_disposal(String disposal)
Parameters:
disposal -

setAutoRemoveDate

public void setAutoRemoveDate(Date autoRemoveDate)

Refinement of disposal

The date on which the resource will automatically be removed from the system.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
autoRemoveDate -

set_autoRemoveDate

public void set_autoRemoveDate(String autoRemoveDate)
Parameters:
autoRemoveDate -

setDisposalAction

public void setDisposalAction(String disposalAction)

Refinement of disposal

The action to be taken once the condition is reached.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
disposalAction -

set_disposalAction

public void set_disposalAction(String disposalAction)
Parameters:
disposalAction -

setDisposalAuthorisedBy

public void setDisposalAuthorisedBy(String[] disposalAuthorisedBy)

Refinement of disposal

The identity of the role, the person or the policy authorising the disposal.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
disposalAuthorisedBy -

set_disposalAuthorisedBy

public void set_disposalAuthorisedBy(String disposalAuthorisedBy)
Parameters:
disposalAuthorisedBy -

setDisposalComment

public void setDisposalComment(String disposalComment)

Refinement of disposal

The reason for disposal.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
disposalComment -

set_disposalComment

public void set_disposalComment(String disposalComment)
Parameters:
disposalComment -

setDisposalConditions

public void setDisposalConditions(String disposalConditions)

Refinement of disposal

An event that triggers disposal of the resource, e.g. closure of folder.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
disposalConditions -

set_disposalConditions

public void set_disposalConditions(String disposalConditions)
Parameters:
disposalConditions -

setDisposalDate

public void setDisposalDate(Date disposalDate)

Refinement of disposal

The date the disposal action is due to take place, i.e. from the disposal event, plus the disposal time period.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
disposalDate -

set_disposalDate

public void set_disposalDate(String disposalDate)
Parameters:
disposalDate -

setDateOfLastReview

public void setDateOfLastReview(Date dateOfLastReview)

Refinement of disposal

The date the disposal schedule was last reviewed

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
dateOfLastReview -

set_dateOfLastReview

public void set_dateOfLastReview(String dateOfLastReview)
Parameters:
dateOfLastReview -

setDisposalExportDestination

public void setDisposalExportDestination(String disposalExportDestination)

Refinement of disposal

The location where an exported resource will be disposed, e.g. National Archives for permanent preservation.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
disposalExportDestination -

set_disposalExportDestination

public void set_disposalExportDestination(String disposalExportDestination)
Parameters:
disposalExportDestination -

setDisposalExportStatus

public void setDisposalExportStatus(String disposalExportStatus)

Refinement of disposal

Information about the progress of the export, e.g. pending, already executed, failed.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
disposalExportStatus -

set_disposalExportStatus

public void set_disposalExportStatus(String disposalExportStatus)
Parameters:
disposalExportStatus -

setDisposalReview

public void setDisposalReview(String disposalReview)

Refinement of disposal

The date on which the resource should be reviewed to determine the need to retain it.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
disposalReview -

set_disposalReview

public void set_disposalReview(String disposalReview)
Parameters:
disposalReview -

setDisposalReviewDetails

public void setDisposalReviewDetails(String disposalReviewDetails)

Refinement of disposal

The details of the review decision which has been taken.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
disposalReviewDetails -

set_disposalReviewDetails

public void set_disposalReviewDetails(String disposalReviewDetails)
Parameters:
disposalReviewDetails -

setDisposalReviewerDetails

public void setDisposalReviewerDetails(String[] disposalReviewerDetails)

Refinement of disposal

The identity of the reviewer.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
disposalReviewerDetails -

set_disposalReviewerDetails

public void set_disposalReviewerDetails(String disposalReviewerDetails)
Parameters:
disposalReviewerDetails -

setDisposalScheduleID

public void setDisposalScheduleID(String disposalScheduleID)

Refinement of disposal

The disposal schedule used to determine the disposal of the resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
disposalScheduleID -

set_disposalScheduleID

public void set_disposalScheduleID(String disposalScheduleID)
Parameters:
disposalScheduleID -

setDisposalTimePeriod

public void setDisposalTimePeriod(String disposalTimePeriod)

Refinement of disposal

A specific period of time following a specific event determining the period for which the resource must be kept for business purposes.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
disposalTimePeriod -

set_disposalTimePeriod

public void set_disposalTimePeriod(String disposalTimePeriod)
Parameters:
disposalTimePeriod -

setExtent

public void setExtent(String extent)

Refinement of format

The size or duration of the resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
extent -

set_extent

public void set_extent(String extent)
Parameters:
extent -

setMedium

public void setMedium(String medium)

Refinement of format

The material or physical carrier of the resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
medium -

set_medium

public void set_medium(String medium)
Parameters:
medium -

setBibliographicCitation

public void setBibliographicCitation(String bibliographicCitation)

Refinement of identifier

A bibliographic reference for the resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
bibliographicCitation -

set_bibliographicCitation

public void set_bibliographicCitation(String bibliographicCitation)
Parameters:
bibliographicCitation -

setFileplanID

public void setFileplanID(String fileplanID)

Refinement of identifier

The reference derived from the fileplan. This is a culmination of information inherited from higher levels of aggregation in the fileplan.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
fileplanID -

set_fileplanID

public void set_fileplanID(String fileplanID)
Parameters:
fileplanID -

setSystemID

public void setSystemID(String systemID)

Refinement of identifier

Typically, a machine-generated running number allocated when the file is first created. This will typically be used by the internal processes and will rarely be visible to the end user, although it can be a useful tool for administrators accessing other information about the file-path object (e.g. interrogating the audit trail).

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
systemID -

set_systemID

public void set_systemID(String systemID)
Parameters:
systemID -

setLocation

public void setLocation(String location)

The physical location of the resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
location -

set_location

public void set_location(String location)
Parameters:
location -

setCurrentLocation

public void setCurrentLocation(String currentLocation)

Refinement of location

The temporary place the resource is located, e.g. the name and address of a person who has checked out a disc.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
currentLocation -

set_currentLocation

public void set_currentLocation(String currentLocation)
Parameters:
currentLocation -

setHomeLocation

public void setHomeLocation(String homeLocation)

Refinement of location

The place the resource is normally stored.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
homeLocation -

set_homeLocation

public void set_homeLocation(String homeLocation)
Parameters:
homeLocation -

setMandate

public void setMandate(String mandate)

Legislative or other mandate under which the resource was produced.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
mandate -

set_mandate

public void set_mandate(String mandate)
Parameters:
mandate -

setAuthorisingStatute

public void setAuthorisingStatute(String authorisingStatute)

Refinement of mandate

The Act of Parliament or other legislation authorising the capture of information or development of the resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
authorisingStatute -

set_authorisingStatute

public void set_authorisingStatute(String authorisingStatute)
Parameters:
authorisingStatute -

setDataProtectionExemptCategory

public void setDataProtectionExemptCategory(String[] dataProtectionExemptCategory)

Refinement of mandate

One or more exemption clauses as defined in the Data Protection Act Part 4 (DPA), which applies to this resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
dataProtectionExemptCategory -

set_dataProtectionExemptCategory

public void set_dataProtectionExemptCategory(String dataProtectionExemptCategory)
Parameters:
dataProtectionExemptCategory -

setPersonalDataAquisitionPurpose

public void setPersonalDataAquisitionPurpose(String[] personalDataAquisitionPurpose)

Refinement of mandate

Reason for the collection and storage of personal data.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
personalDataAquisitionPurpose -

set_personalDataAquisitionPurpose

public void set_personalDataAquisitionPurpose(String personalDataAquisitionPurpose)
Parameters:
personalDataAquisitionPurpose -

setPreservation

public void setPreservation(String preservation)

Information to support the long-term preservation of a resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
preservation -

set_preservation

public void set_preservation(String preservation)
Parameters:
preservation -

setOriginalFormat

public void setOriginalFormat(String originalFormat)

Refinement of preservation

The original format of the resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
originalFormat -

set_originalFormat

public void set_originalFormat(String originalFormat)
Parameters:
originalFormat -

setConformsTo

public void setConformsTo(String[] conformsTo)

Refinement of relation

A reference to an established standard to which the resource conforms.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
conformsTo -

set_conformsTo

public void set_conformsTo(String conformsTo)
Parameters:
conformsTo -

setHasFormat

public void setHasFormat(String[] hasFormat)

Refinement of relation

The described resource pre-existed the referenced resource, which is essentially the same intellectual content presented in another format.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
hasFormat -

set_hasFormat

public void set_hasFormat(String hasFormat)
Parameters:
hasFormat -

setHasVersion

public void setHasVersion(String[] hasVersion)

Refinement of relation

The described resource has a version, edition, or adaptation, namely, the referenced resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
hasVersion -

set_hasVersion

public void set_hasVersion(String hasVersion)
Parameters:
hasVersion -

setHasPart

public void setHasPart(String[] hasPart)

Refinement of relation

The described resource includes the referenced resource either physically or logically.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
hasPart -

set_hasPart

public void set_hasPart(String hasPart)
Parameters:
hasPart -

setIsDefinedBy

public void setIsDefinedBy(String[] isDefinedBy)

Refinement of relation

The described resource is given an effective working definition by the referenced resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
isDefinedBy -

set_isDefinedBy

public void set_isDefinedBy(String isDefinedBy)
Parameters:
isDefinedBy -

setIsFormatOf

public void setIsFormatOf(String[] isFormatOf)

Refinement of relation

The described resource is the same intellectual content of the referenced resource, but presented in another format.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
isFormatOf -

set_isFormatOf

public void set_isFormatOf(String isFormatOf)
Parameters:
isFormatOf -

setIsPartOf

public void setIsPartOf(String[] isPartOf)

Refinement of relation

The described resource is a physical or logical part of the referenced resource.Comments: When the described resource is part of another, it may be possible for it to inherit metadata elements from the parent resource. For example, the subject metadata of a folder may be inherited by all of the files within that folder.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
isPartOf -

set_isPartOf

public void set_isPartOf(String isPartOf)
Parameters:
isPartOf -

setIsReferencedBy

public void setIsReferencedBy(String[] isReferencedBy)

Refinement of relation

The described resource is referenced, cited, or otherwise pointed to by the referenced resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
isReferencedBy -

set_isReferencedBy

public void set_isReferencedBy(String isReferencedBy)
Parameters:
isReferencedBy -

setIsReplacedBy

public void setIsReplacedBy(String[] isReplacedBy)

Refinement of relation

The described resource is supplanted, displaced, or superseded by the referenced resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
isReplacedBy -

set_isReplacedBy

public void set_isReplacedBy(String isReplacedBy)
Parameters:
isReplacedBy -

setIsRequiredBy

public void setIsRequiredBy(String[] isRequiredBy)

Refinement of relation

The described resource is required by the referenced resource to support its function, delivery, or coherence of content.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
isRequiredBy -

set_isRequiredBy

public void set_isRequiredBy(String isRequiredBy)
Parameters:
isRequiredBy -

setIsVersionOf

public void setIsVersionOf(String isVersionOf)

Refinement of relation

The described resource is a version, edition, or adaptation of the referenced resource. A change in version implies substantive changes in content rather than differences in format. Includes translations of resources.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
isVersionOf -

set_isVersionOf

public void set_isVersionOf(String isVersionOf)
Parameters:
isVersionOf -

setProvidesDefinitionOf

public void setProvidesDefinitionOf(String providesDefinitionOf)

Refinement of relation

The described resource provides an effective working definition of an item whose usual name is given in the value.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
providesDefinitionOf -

set_providesDefinitionOf

public void set_providesDefinitionOf(String providesDefinitionOf)
Parameters:
providesDefinitionOf -

setReasonForRedaction

public void setReasonForRedaction(String reasonForRedaction)

Refinement of relation

The reason for the publication of a redaction or extract.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
reasonForRedaction -

set_reasonForRedaction

public void set_reasonForRedaction(String reasonForRedaction)
Parameters:
reasonForRedaction -

setRedaction

public void setRedaction(String redaction)

Refinement of relation

The described resource has a version with some part of the content marked or removed to make the remainder of the content releasable.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
redaction -

set_redaction

public void set_redaction(String redaction)
Parameters:
redaction -

setResourceReferences

public void setResourceReferences(String[] resourceReferences)

Refinement of relation

The described resource references, cites, or otherwise points to the referenced resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
resourceReferences -

set_resourceReferences

public void set_resourceReferences(String resourceReferences)
Parameters:
resourceReferences -

setRequires

public void setRequires(String[] requires)

Refinement of relation

The described resource requires the referenced resource to support its function, delivery, or coherence of content.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
requires -

set_requires

public void set_requires(String requires)
Parameters:
requires -

setReplaces

public void setReplaces(String[] replaces)

Refinement of relation

The described resource supplants, displaces, or supersedes the referenced resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
replaces -

set_replaces

public void set_replaces(String replaces)
Parameters:
replaces -

setSequenceNum

public void setSequenceNum(String sequenceNum)

Refinement of relation

The resource’s allocated number in a sequence to which it belongs.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
sequenceNum -

set_sequenceNum

public void set_sequenceNum(String sequenceNum)
Parameters:
sequenceNum -

setCopyright

public void setCopyright(String[] copyright)

Refinement of rights

Statement and identifier indicating the legal ownership and rights regarding use and re-use of all or part of the resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
copyright -

set_copyright

public void set_copyright(String copyright)
Parameters:
copyright -

setCustodian

public void setCustodian(String[] custodian)

Refinement of rights

The user or role identifier with local management powers over the resource, e.g. assignment and maintenance of access control markings.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
custodian -

set_custodian

public void set_custodian(String custodian)
Parameters:
custodian -

setDescriptor

public void setDescriptor(String descriptor)

Refinement of rights

Refines the meaning of a protective marking, e.g. Policy, Contracts, Personnel. It may be used with group access permissions to determine access rights.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
descriptor -

set_descriptor

public void set_descriptor(String descriptor)
Parameters:
descriptor -

setDisclosabilityToDPADataSubject

public void setDisclosabilityToDPADataSubject(String disclosabilityToDPADataSubject)

Refinement of rights

Whether the resource can be disclosed (‘Y’ or ‘N’) in accordance with the DPA (Data Protection Act).

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
disclosabilityToDPADataSubject -

set_disclosabilityToDPADataSubject

public void set_disclosabilityToDPADataSubject(String disclosabilityToDPADataSubject)
Parameters:
disclosabilityToDPADataSubject -

setDPADataSubjectAccessExemption

public void setDPADataSubjectAccessExemption(String dPADataSubjectAccessExemption)

Refinement of rights

Whether the resource is exempt from DPA access provisions (‘Y’ or ‘N’).

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
dPADataSubjectAccessExemption -

set_dPADataSubjectAccessExemption

public void set_dPADataSubjectAccessExemption(String dPADataSubjectAccessExemption)
Parameters:
dPADataSubjectAccessExemption -

setEIRDisclosabilityIndicator

public void setEIRDisclosabilityIndicator(String eIRDisclosabilityIndicator)

Refinement of rights

Whether the resource can be disclosed (‘Y’ or ‘N’) in accordance with the EIR (Environmental Information Regulations).

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
eIRDisclosabilityIndicator -

set_eIRDisclosabilityIndicator

public void set_eIRDisclosabilityIndicator(String eIRDisclosabilityIndicator)
Parameters:
eIRDisclosabilityIndicator -

setEIRExemption

public void setEIRExemption(String eIRExemption)

Refinement of rights

Whether there are exemptions to access to the resource (‘Y’ or ‘N’) in accordance with the EIR.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
eIRExemption -

set_eIRExemption

public void set_eIRExemption(String eIRExemption)
Parameters:
eIRExemption -

setFOIDisclosabilityIndicator

public void setFOIDisclosabilityIndicator(String fOIDisclosabilityIndicator)

Refinement of rights

Whether the resource can be disclosed (‘Y’ or ‘N’) in accordance with the FOI (Freedom of Information Act).

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
fOIDisclosabilityIndicator -

set_fOIDisclosabilityIndicator

public void set_fOIDisclosabilityIndicator(String fOIDisclosabilityIndicator)
Parameters:
fOIDisclosabilityIndicator -

setFOIExemption

public void setFOIExemption(String fOIExemption)

Refinement of rights

Whether there are exemptions to access to the resource (‘Y’ or ‘N’) in accordance with the FOI.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
fOIExemption -

set_fOIExemption

public void set_fOIExemption(String fOIExemption)
Parameters:
fOIExemption -

setFOIReleaseDetails

public void setFOIReleaseDetails(String[] fOIReleaseDetails)

Refinement of rights

The details of the past or future release of the resource to public view either by general publication or by release in response to an individual request.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
fOIReleaseDetails -

set_fOIReleaseDetails

public void set_fOIReleaseDetails(String fOIReleaseDetails)
Parameters:
fOIReleaseDetails -

setFOIReleaseDate

public void setFOIReleaseDate(Date fOIReleaseDate)

Refinement of rights

The date of past or future release.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
fOIReleaseDate -

set_fOIReleaseDate

public void set_fOIReleaseDate(String fOIReleaseDate)
Parameters:
fOIReleaseDate -

setGroupAccess

public void setGroupAccess(String[] groupAccess)

Refinement of rights

Name of a group or groups which have the right to access the resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
groupAccess -

set_groupAccess

public void set_groupAccess(String groupAccess)
Parameters:
groupAccess -

setIndividualUserAccessList

public void setIndividualUserAccessList(String[] individualUserAccessList)

Refinement of rights

Names of individuals having access to the resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
individualUserAccessList -

set_individualUserAccessList

public void set_individualUserAccessList(String individualUserAccessList)
Parameters:
individualUserAccessList -

setLastFOIDisclosabilityReview

public void setLastFOIDisclosabilityReview(String lastFOIDisclosabilityReview)

Refinement of rights

The date of the previous formal decision regarding the disclosability of a resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
lastFOIDisclosabilityReview -

set_lastFOIDisclosabilityReview

public void set_lastFOIDisclosabilityReview(String lastFOIDisclosabilityReview)
Parameters:
lastFOIDisclosabilityReview -

setPreviousProtectiveMarking

public void setPreviousProtectiveMarking(String[] previousProtectiveMarking)

Refinement of rights

Protective marking previously applied to a resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
previousProtectiveMarking -

set_previousProtectiveMarking

public void set_previousProtectiveMarking(String previousProtectiveMarking)
Parameters:
previousProtectiveMarking -

setProtectiveMarking

public void setProtectiveMarking(String protectiveMarking)

Refinement of rights

The minimum level of security required to have access to the resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
protectiveMarking -

set_protectiveMarking

public void set_protectiveMarking(String protectiveMarking)
Parameters:
protectiveMarking -

setProtectiveMarkingChangeDate

public void setProtectiveMarkingChangeDate(Date protectiveMarkingChangeDate)

Refinement of rights

The date the previous protective marking was superseded.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
protectiveMarkingChangeDate -

set_protectiveMarkingChangeDate

public void set_protectiveMarkingChangeDate(String protectiveMarkingChangeDate)
Parameters:
protectiveMarkingChangeDate -

setProtectiveMarkingExpiryDate

public void setProtectiveMarkingExpiryDate(Date protectiveMarkingExpiryDate)

Refinement of rights

Date on which the existing protective marking becomes invalid.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
protectiveMarkingExpiryDate -

set_protectiveMarkingExpiryDate

public void set_protectiveMarkingExpiryDate(String protectiveMarkingExpiryDate)
Parameters:
protectiveMarkingExpiryDate -

setStatus

public void setStatus(String status)

The position or state of the resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
status -

set_status

public void set_status(String status)
Parameters:
status -

setCategory

public void setCategory(String[] category)

Refinement of subject

Broad subject categories from the Government Category List, and, optionally, any other widely available category list.Comment: This is to allow users to scroll down through a list of very broad terms (e.g. Business and Industry) to narrower categories (e.g. Companies, Imports).

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
category -

set_category

public void set_category(String category)
Parameters:
category -

setKeyword

public void setKeyword(String[] keyword)

Refinement of subject

Words or terms used to describe, as specifically as possible, the subject matter of the resource. These should be taken from a controlled vocabulary or list.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
keyword -

set_keyword

public void set_keyword(String keyword)
Parameters:
keyword -

setProcessIdentifier

public void setProcessIdentifier(String[] processIdentifier)

Refinement of subject

Indicates a specific service or transaction, using an identifier taken from a recognised list.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
processIdentifier -

set_processIdentifier

public void set_processIdentifier(String processIdentifier)
Parameters:
processIdentifier -

setProgramme

public void setProgramme(String[] programme)

Refinement of subject

The broader policy programme to which this resource relates directly.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
programme -

set_programme

public void set_programme(String programme)
Parameters:
programme -

setProject

public void setProject(String[] project)

Refinement of subject

The specific project that this resource relates to directly.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
project -

set_project

public void set_project(String project)
Parameters:
project -

setAlternativeTitle

public void setAlternativeTitle(String[] alternativeTitle)

Refinement of title

Any form of the title used as a substitute or alternative to the formal title of the resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Parameters:
alternativeTitle -

set_alternativeTitle

public void set_alternativeTitle(String alternativeTitle)
Parameters:
alternativeTitle -

setDatesModified

public void setDatesModified(String[] datesModified)

An array of modification dates (currently stored as Strings as Data arrays are not yet supported).

Parameters:
datesModified -

set_datesModified

public void set_datesModified(String datesModified)
Parameters:
datesModified -

setAccessibility

public void setAccessibility(String accessibility)
Parameters:
accessibility -
This property replaces:
accessability

set_accessibility

public void set_accessibility(String accessibility)
Parameters:
accessibility -

setDateAquired

public void setDateAquired(Date dateAquired)

Incorrectly spelled property.

Replaced by EGMSResource2.dateAcquired.

Parameters:
dateAquired -

set_dateAquired

public void set_dateAquired(String dateAquired)
Parameters:
dateAquired -

getAllInstances

public static Vector getAllInstances(RDFDB db)
                              throws Exception
Parameters:
db - the db where the instances are to be found
Returns:
all the instances of this class in the database
Throws:
Exception

getAllInstances

public static Vector getAllInstances()
                              throws Exception
Returns:
get all the instances of this class from the default database
Throws:
Exception

getInstance

public static Resource getInstance(RDFDB db,
                                   URL id)
                            throws Exception
If an object of type EGMSResource with the indicated id exists in the db returns it otherwise create a new object in the db and returns it

Parameters:
db - the db where the object is to be found or created
id - the id of the object to retrieve or create
Returns:
an object of type Server with the indicated id and existing in the indicated db
Throws:
Exception

getInstance

public static Resource getInstance(String rdf)
                            throws Exception
Parameters:
rdf - some rdf code that contains a description of an object of this kind
Returns:
the single instance of this class described in the passed RDF code
Throws:
Exception

get_study

public RDFRef get_study()
                 throws Exception
Throws:
Exception

getStudy

public Study2 getStudy()
Returns:

get_person

public RDFRef get_person()
                  throws Exception
Throws:
Exception

getPerson

public Person getPerson()
Returns:

get_event

public RDFRef get_event()
                 throws Exception
Throws:
Exception

getEvent

public Event getEvent()
Returns:

getComment

public String getComment()

An account of the content of the resource. Maps to description

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf

Overrides:
getComment in class RDFObject
Returns:
the comment
This property stores the contents of the DDI field:
<codeBook><stdyDscr><othrStdyMat><relMat>, <codeBook><stdyDscr><othrStdyMat><relStdy>, <codeBook><stdyDscr><othrStdyMat><relPubl>, <codeBook><stdyDscr><othrStdyMat><othRefs>

getUri

public String getUri()

This property stores the contents of the DDI field:
<codeBook><stdyDscr><othrStdyMat><relMat><citation><holdings URI>, <codeBook><stdyDscr><othrStdyMat><relStdy><citation><holdings URI>, <codeBook><stdyDscr><othrStdyMat><relPubl><citation><holdings URI>, <codeBook><stdyDscr><othrStdyMat><othRefs><citation><holdings URI>

get_uri

public String get_uri()
               throws Exception
Throws:
Exception

getNotes

public String getNotes()

Non e-GMS field. Used for citation.notes in relatedMaterials

This property stores the contents of the DDI field:
<codeBook><stdyDscr><othrStdyMat><relMat><citation><notes>, <codeBook><stdyDscr><othrStdyMat><relStdy><citation><notes>, <codeBook><stdyDscr><othrStdyMat><relPubl><citation><notes>, <codeBook><stdyDscr><othrStdyMat><othRefs><citation><notes>

get_notes

public String get_notes()
                 throws Exception
Throws:
Exception

getAccessability

public String getAccessability()
Deprecated. replaced by accessibility

Indicates the resource’s availability and usability to specific groups.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_accessability

public String get_accessability()
                         throws Exception
Throws:
Exception

getAddressee

public String[] getAddressee()

The person (or persons) to whom the resource was addressed.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


getAddresseeAsString

public String getAddresseeAsString()

get_addressee

public String get_addressee()
                     throws Exception
Throws:
Exception

getAggregation

public String getAggregation()

The resource’s level or position in a hierarchy.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_aggregation

public String get_aggregation()
                       throws Exception
Throws:
Exception

getAudience

public String getAudience()

A category of user for whom the resource is intended.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_audience

public String get_audience()
                    throws Exception
Throws:
Exception

getEducationLevel

public String getEducationLevel()

Refinement of audience

A general statement describing the education or training context. Alternatively, a more specific statement of the location of the audience in terms of its progression through an education or training context.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_educationLevel

public String get_educationLevel()
                          throws Exception
Throws:
Exception

getMediator

public String getMediator()

Refinement of audience

A class of entity that mediates access to the resource and for whom the resource is intended or useful.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_mediator

public String get_mediator()
                    throws Exception
Throws:
Exception

getTemporal

public String[] getTemporal()

Refinement of coverage

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


getTemporalAsString

public String getTemporalAsString()

get_temporal

public String get_temporal()
                    throws Exception
Throws:
Exception

getBeginningDate

public Date getBeginningDate()

Refinement of coverage.temporal

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_beginningDate

public String get_beginningDate()
                         throws Exception
Throws:
Exception

getEndDate

public Date getEndDate()

Refinement of coverage.temporal

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_endDate

public String get_endDate()
                   throws Exception
Throws:
Exception

getDateCapturePeriod

public String[] getDateCapturePeriod()

Refinement of coverage.temporal

If the elements of this array are ranges the end periods should be stored in EGMSResource2.coverageSpatialDateCapturePeriodEnds.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


getDateCapturePeriodAsString

public String getDateCapturePeriodAsString()

get_dateCapturePeriod

public String get_dateCapturePeriod()
                             throws Exception
Throws:
Exception

getStatusOfStartDateOfCapture

public String getStatusOfStartDateOfCapture()

Refinement of coverage.temporal

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_statusOfStartDateOfCapture

public String get_statusOfStartDateOfCapture()
                                      throws Exception
Throws:
Exception

getStartDateOfCapture

public Date getStartDateOfCapture()

Refinement of coverage.temporal

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_startDateOfCapture

public String get_startDateOfCapture()
                              throws Exception
Throws:
Exception

getEndDateOfCapture

public Date getEndDateOfCapture()

Refinement of coverage.temporal

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_endDateOfCapture

public String get_endDateOfCapture()
                            throws Exception
Throws:
Exception

getSpatial

public String[] getSpatial()

Refinement of coverage

Note: it is preferable to avoid using this field and use postcode or spatialLocation instead.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


getSpatialAsString

public String getSpatialAsString()

get_spatial

public String get_spatial()
                   throws Exception
Throws:
Exception

getPostcode

public String[] getPostcode()

Refinement of coverage.spatial

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


getPostcodeAsString

public String getPostcodeAsString()

get_postcode

public String get_postcode()
                    throws Exception
Throws:
Exception

getSpatialLocation

public String[] getSpatialLocation()

Refinement of coverage.spatial

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


getSpatialLocationAsString

public String getSpatialLocationAsString()

get_spatialLocation

public String get_spatialLocation()
                           throws Exception
Throws:
Exception

getDateAvailable

public Date getDateAvailable()

Refinement of date

Date that the resource will become or did become available.

If it is a range this field stores the initial date and EGMSResource2.dateAvailableEnd stores the end date.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_dateAvailable

public String get_dateAvailable()
                         throws Exception
Throws:
Exception

getDateCreated

public Date getDateCreated()

Refinement of date

Date of creation of the resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_dateCreated

public String get_dateCreated()
                       throws Exception
Throws:
Exception

getCutOffDate

public Date getCutOffDate()

Refinement of date

Date from which the resource should no longer be added to or modified.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_cutOffDate

public String get_cutOffDate()
                      throws Exception
Throws:
Exception

getDateClosed

public Date getDateClosed()

Refinement of date

Date which the capacity to store the resource as part of a collection was revoked.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_dateClosed

public String get_dateClosed()
                      throws Exception
Throws:
Exception

getDateAccepted

public Date getDateAccepted()

Refinement of date

Date of acceptance of the resource (e.g. of thesis by university department, of article by journal etc.).

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_dateAccepted

public String get_dateAccepted()
                        throws Exception
Throws:
Exception

getDateCopyrighted

public Date getDateCopyrighted()

Refinement of date

Date of a statement of copyright. Use if date is different from date.created or if date.created is not given.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_dateCopyrighted

public String get_dateCopyrighted()
                           throws Exception
Throws:
Exception

getDateSubmitted

public Date getDateSubmitted()

Refinement of date

Date of submission of the resource (e.g. thesis, article etc.).

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_dateSubmitted

public String get_dateSubmitted()
                         throws Exception
Throws:
Exception

getDateDeclared

public Date getDateDeclared()

Refinement of date

Date on which the resource was declared, filed or stored.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_dateDeclared

public String get_dateDeclared()
                        throws Exception
Throws:
Exception

getDateIssued

public Date getDateIssued()

Refinement of date

Date of formal issuance (e.g. publication) of the resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_dateIssued

public String get_dateIssued()
                      throws Exception
Throws:
Exception

getDateModified

public Date getDateModified()

Refinement of date

Date on which the resource was changed.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_dateModified

public String get_dateModified()
                        throws Exception
Throws:
Exception

getDateNextVersionDue

public Date getDateNextVersionDue()

Refinement of date

Date on which the resource is due to be superseded.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_dateNextVersionDue

public String get_dateNextVersionDue()
                              throws Exception
Throws:
Exception

getUpdatingFrequency

public String getUpdatingFrequency()

Refinement of date

How often the resource is updated.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_updatingFrequency

public String get_updatingFrequency()
                             throws Exception
Throws:
Exception

getDateValid

public Date getDateValid()

Refinement of date

The date of validity of a resource.

If it is a range this field stores the initial date and EGMSResource2.dateValidEnd stores the end date.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_dateValid

public String get_dateValid()
                     throws Exception
Throws:
Exception

getAbstractText

public String getAbstractText()

Refinement of description

A summary of the content of the resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_abstractText

public String get_abstractText()
                        throws Exception
Throws:
Exception

getTableOfContents

public String getTableOfContents()

Refinement of description

A list of sub-units of the content of the resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_tableOfContents

public String get_tableOfContents()
                           throws Exception
Throws:
Exception

getDigitalSignature

public String getDigitalSignature()

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_digitalSignature

public String get_digitalSignature()
                            throws Exception
Throws:
Exception

getDisposal

public String getDisposal()

The retention and disposal instructions for the resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_disposal

public String get_disposal()
                    throws Exception
Throws:
Exception

getAutoRemoveDate

public Date getAutoRemoveDate()

Refinement of disposal

The date on which the resource will automatically be removed from the system.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_autoRemoveDate

public String get_autoRemoveDate()
                          throws Exception
Throws:
Exception

getDisposalAction

public String getDisposalAction()

Refinement of disposal

The action to be taken once the condition is reached.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_disposalAction

public String get_disposalAction()
                          throws Exception
Throws:
Exception

getDisposalAuthorisedBy

public String[] getDisposalAuthorisedBy()

Refinement of disposal

The identity of the role, the person or the policy authorising the disposal.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


getDisposalAuthorisedByAsString

public String getDisposalAuthorisedByAsString()

get_disposalAuthorisedBy

public String get_disposalAuthorisedBy()
                                throws Exception
Throws:
Exception

getDisposalComment

public String getDisposalComment()

Refinement of disposal

The reason for disposal.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_disposalComment

public String get_disposalComment()
                           throws Exception
Throws:
Exception

getDisposalConditions

public String getDisposalConditions()

Refinement of disposal

An event that triggers disposal of the resource, e.g. closure of folder.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_disposalConditions

public String get_disposalConditions()
                              throws Exception
Throws:
Exception

getDisposalDate

public Date getDisposalDate()

Refinement of disposal

The date the disposal action is due to take place, i.e. from the disposal event, plus the disposal time period.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_disposalDate

public String get_disposalDate()
                        throws Exception
Throws:
Exception

getDateOfLastReview

public Date getDateOfLastReview()

Refinement of disposal

The date the disposal schedule was last reviewed

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_dateOfLastReview

public String get_dateOfLastReview()
                            throws Exception
Throws:
Exception

getDisposalExportDestination

public String getDisposalExportDestination()

Refinement of disposal

The location where an exported resource will be disposed, e.g. National Archives for permanent preservation.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_disposalExportDestination

public String get_disposalExportDestination()
                                     throws Exception
Throws:
Exception

getDisposalExportStatus

public String getDisposalExportStatus()

Refinement of disposal

Information about the progress of the export, e.g. pending, already executed, failed.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_disposalExportStatus

public String get_disposalExportStatus()
                                throws Exception
Throws:
Exception

getDisposalReview

public String getDisposalReview()

Refinement of disposal

The date on which the resource should be reviewed to determine the need to retain it.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_disposalReview

public String get_disposalReview()
                          throws Exception
Throws:
Exception

getDisposalReviewDetails

public String getDisposalReviewDetails()

Refinement of disposal

The details of the review decision which has been taken.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_disposalReviewDetails

public String get_disposalReviewDetails()
                                 throws Exception
Throws:
Exception

getDisposalReviewerDetails

public String[] getDisposalReviewerDetails()

Refinement of disposal

The identity of the reviewer.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


getDisposalReviewerDetailsAsString

public String getDisposalReviewerDetailsAsString()

get_disposalReviewerDetails

public String get_disposalReviewerDetails()
                                   throws Exception
Throws:
Exception

getDisposalScheduleID

public String getDisposalScheduleID()

Refinement of disposal

The disposal schedule used to determine the disposal of the resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_disposalScheduleID

public String get_disposalScheduleID()
                              throws Exception
Throws:
Exception

getDisposalTimePeriod

public String getDisposalTimePeriod()

Refinement of disposal

A specific period of time following a specific event determining the period for which the resource must be kept for business purposes.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_disposalTimePeriod

public String get_disposalTimePeriod()
                              throws Exception
Throws:
Exception

getExtent

public String getExtent()

Refinement of format

The size or duration of the resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_extent

public String get_extent()
                  throws Exception
Throws:
Exception

getMedium

public String getMedium()

Refinement of format

The material or physical carrier of the resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_medium

public String get_medium()
                  throws Exception
Throws:
Exception

getBibliographicCitation

public String getBibliographicCitation()

Refinement of identifier

A bibliographic reference for the resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_bibliographicCitation

public String get_bibliographicCitation()
                                 throws Exception
Throws:
Exception

getFileplanID

public String getFileplanID()

Refinement of identifier

The reference derived from the fileplan. This is a culmination of information inherited from higher levels of aggregation in the fileplan.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_fileplanID

public String get_fileplanID()
                      throws Exception
Throws:
Exception

getSystemID

public String getSystemID()

Refinement of identifier

Typically, a machine-generated running number allocated when the file is first created. This will typically be used by the internal processes and will rarely be visible to the end user, although it can be a useful tool for administrators accessing other information about the file-path object (e.g. interrogating the audit trail).

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_systemID

public String get_systemID()
                    throws Exception
Throws:
Exception

getLocation

public String getLocation()

The physical location of the resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_location

public String get_location()
                    throws Exception
Throws:
Exception

getCurrentLocation

public String getCurrentLocation()

Refinement of location

The temporary place the resource is located, e.g. the name and address of a person who has checked out a disc.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_currentLocation

public String get_currentLocation()
                           throws Exception
Throws:
Exception

getHomeLocation

public String getHomeLocation()

Refinement of location

The place the resource is normally stored.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_homeLocation

public String get_homeLocation()
                        throws Exception
Throws:
Exception

getMandate

public String getMandate()

Legislative or other mandate under which the resource was produced.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_mandate

public String get_mandate()
                   throws Exception
Throws:
Exception

getAuthorisingStatute

public String getAuthorisingStatute()

Refinement of mandate

The Act of Parliament or other legislation authorising the capture of information or development of the resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_authorisingStatute

public String get_authorisingStatute()
                              throws Exception
Throws:
Exception

getDataProtectionExemptCategory

public String[] getDataProtectionExemptCategory()

Refinement of mandate

One or more exemption clauses as defined in the Data Protection Act Part 4 (DPA), which applies to this resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


getDataProtectionExemptCategoryAsString

public String getDataProtectionExemptCategoryAsString()

get_dataProtectionExemptCategory

public String get_dataProtectionExemptCategory()
                                        throws Exception
Throws:
Exception

getPersonalDataAquisitionPurpose

public String[] getPersonalDataAquisitionPurpose()

Refinement of mandate

Reason for the collection and storage of personal data.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


getPersonalDataAquisitionPurposeAsString

public String getPersonalDataAquisitionPurposeAsString()

get_personalDataAquisitionPurpose

public String get_personalDataAquisitionPurpose()
                                         throws Exception
Throws:
Exception

getPreservation

public String getPreservation()

Information to support the long-term preservation of a resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_preservation

public String get_preservation()
                        throws Exception
Throws:
Exception

getOriginalFormat

public String getOriginalFormat()

Refinement of preservation

The original format of the resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_originalFormat

public String get_originalFormat()
                          throws Exception
Throws:
Exception

getConformsTo

public String[] getConformsTo()

Refinement of relation

A reference to an established standard to which the resource conforms.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


getConformsToAsString

public String getConformsToAsString()

get_conformsTo

public String get_conformsTo()
                      throws Exception
Throws:
Exception

getHasFormat

public String[] getHasFormat()

Refinement of relation

The described resource pre-existed the referenced resource, which is essentially the same intellectual content presented in another format.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


getHasFormatAsString

public String getHasFormatAsString()

get_hasFormat

public String get_hasFormat()
                     throws Exception
Throws:
Exception

getHasVersion

public String[] getHasVersion()

Refinement of relation

The described resource has a version, edition, or adaptation, namely, the referenced resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


getHasVersionAsString

public String getHasVersionAsString()

get_hasVersion

public String get_hasVersion()
                      throws Exception
Throws:
Exception

getHasPart

public String[] getHasPart()

Refinement of relation

The described resource includes the referenced resource either physically or logically.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


getHasPartAsString

public String getHasPartAsString()

get_hasPart

public String get_hasPart()
                   throws Exception
Throws:
Exception

getIsDefinedBy

public String[] getIsDefinedBy()

Refinement of relation

The described resource is given an effective working definition by the referenced resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


getIsDefinedByAsString

public String getIsDefinedByAsString()

get_isDefinedBy

public String get_isDefinedBy()
                       throws Exception
Throws:
Exception

getIsFormatOf

public String[] getIsFormatOf()

Refinement of relation

The described resource is the same intellectual content of the referenced resource, but presented in another format.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


getIsFormatOfAsString

public String getIsFormatOfAsString()

get_isFormatOf

public String get_isFormatOf()
                      throws Exception
Throws:
Exception

getIsPartOf

public String[] getIsPartOf()

Refinement of relation

The described resource is a physical or logical part of the referenced resource.Comments: When the described resource is part of another, it may be possible for it to inherit metadata elements from the parent resource. For example, the subject metadata of a folder may be inherited by all of the files within that folder.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


getIsPartOfAsString

public String getIsPartOfAsString()

get_isPartOf

public String get_isPartOf()
                    throws Exception
Throws:
Exception

getIsReferencedBy

public String[] getIsReferencedBy()

Refinement of relation

The described resource is referenced, cited, or otherwise pointed to by the referenced resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


getIsReferencedByAsString

public String getIsReferencedByAsString()

get_isReferencedBy

public String get_isReferencedBy()
                          throws Exception
Throws:
Exception

getIsReplacedBy

public String[] getIsReplacedBy()

Refinement of relation

The described resource is supplanted, displaced, or superseded by the referenced resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


getIsReplacedByAsString

public String getIsReplacedByAsString()

get_isReplacedBy

public String get_isReplacedBy()
                        throws Exception
Throws:
Exception

getIsRequiredBy

public String[] getIsRequiredBy()

Refinement of relation

The described resource is required by the referenced resource to support its function, delivery, or coherence of content.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


getIsRequiredByAsString

public String getIsRequiredByAsString()

get_isRequiredBy

public String get_isRequiredBy()
                        throws Exception
Throws:
Exception

getIsVersionOf

public String getIsVersionOf()

Refinement of relation

The described resource is a version, edition, or adaptation of the referenced resource. A change in version implies substantive changes in content rather than differences in format. Includes translations of resources.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_isVersionOf

public String get_isVersionOf()
                       throws Exception
Throws:
Exception

getProvidesDefinitionOf

public String getProvidesDefinitionOf()

Refinement of relation

The described resource provides an effective working definition of an item whose usual name is given in the value.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_providesDefinitionOf

public String get_providesDefinitionOf()
                                throws Exception
Throws:
Exception

getReasonForRedaction

public String getReasonForRedaction()

Refinement of relation

The reason for the publication of a redaction or extract.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_reasonForRedaction

public String get_reasonForRedaction()
                              throws Exception
Throws:
Exception

getRedaction

public String getRedaction()

Refinement of relation

The described resource has a version with some part of the content marked or removed to make the remainder of the content releasable.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_redaction

public String get_redaction()
                     throws Exception
Throws:
Exception

getResourceReferences

public String[] getResourceReferences()

Refinement of relation

The described resource references, cites, or otherwise points to the referenced resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


getResourceReferencesAsString

public String getResourceReferencesAsString()

get_resourceReferences

public String get_resourceReferences()
                              throws Exception
Throws:
Exception

getRequires

public String[] getRequires()

Refinement of relation

The described resource requires the referenced resource to support its function, delivery, or coherence of content.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


getRequiresAsString

public String getRequiresAsString()

get_requires

public String get_requires()
                    throws Exception
Throws:
Exception

getReplaces

public String[] getReplaces()

Refinement of relation

The described resource supplants, displaces, or supersedes the referenced resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


getReplacesAsString

public String getReplacesAsString()

get_replaces

public String get_replaces()
                    throws Exception
Throws:
Exception

getSequenceNum

public String getSequenceNum()

Refinement of relation

The resource’s allocated number in a sequence to which it belongs.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_sequenceNum

public String get_sequenceNum()
                       throws Exception
Throws:
Exception

getCopyright

public String[] getCopyright()

Refinement of rights

Statement and identifier indicating the legal ownership and rights regarding use and re-use of all or part of the resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


getCopyrightAsString

public String getCopyrightAsString()

get_copyright

public String get_copyright()
                     throws Exception
Throws:
Exception

getCustodian

public String[] getCustodian()

Refinement of rights

The user or role identifier with local management powers over the resource, e.g. assignment and maintenance of access control markings.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


getCustodianAsString

public String getCustodianAsString()

get_custodian

public String get_custodian()
                     throws Exception
Throws:
Exception

getDescriptor

public String getDescriptor()

Refinement of rights

Refines the meaning of a protective marking, e.g. Policy, Contracts, Personnel. It may be used with group access permissions to determine access rights.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_descriptor

public String get_descriptor()
                      throws Exception
Throws:
Exception

getDisclosabilityToDPADataSubject

public String getDisclosabilityToDPADataSubject()

Refinement of rights

Whether the resource can be disclosed (‘Y’ or ‘N’) in accordance with the DPA (Data Protection Act).

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_disclosabilityToDPADataSubject

public String get_disclosabilityToDPADataSubject()
                                          throws Exception
Throws:
Exception

getDPADataSubjectAccessExemption

public String getDPADataSubjectAccessExemption()

Refinement of rights

Whether the resource is exempt from DPA access provisions (‘Y’ or ‘N’).

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_dPADataSubjectAccessExemption

public String get_dPADataSubjectAccessExemption()
                                         throws Exception
Throws:
Exception

getEIRDisclosabilityIndicator

public String getEIRDisclosabilityIndicator()

Refinement of rights

Whether the resource can be disclosed (‘Y’ or ‘N’) in accordance with the EIR (Environmental Information Regulations).

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_eIRDisclosabilityIndicator

public String get_eIRDisclosabilityIndicator()
                                      throws Exception
Throws:
Exception

getEIRExemption

public String getEIRExemption()

Refinement of rights

Whether there are exemptions to access to the resource (‘Y’ or ‘N’) in accordance with the EIR.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_eIRExemption

public String get_eIRExemption()
                        throws Exception
Throws:
Exception

getFOIDisclosabilityIndicator

public String getFOIDisclosabilityIndicator()

Refinement of rights

Whether the resource can be disclosed (‘Y’ or ‘N’) in accordance with the FOI (Freedom of Information Act).

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_fOIDisclosabilityIndicator

public String get_fOIDisclosabilityIndicator()
                                      throws Exception
Throws:
Exception

getFOIExemption

public String getFOIExemption()

Refinement of rights

Whether there are exemptions to access to the resource (‘Y’ or ‘N’) in accordance with the FOI.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_fOIExemption

public String get_fOIExemption()
                        throws Exception
Throws:
Exception

getFOIReleaseDetails

public String[] getFOIReleaseDetails()

Refinement of rights

The details of the past or future release of the resource to public view either by general publication or by release in response to an individual request.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


getFOIReleaseDetailsAsString

public String getFOIReleaseDetailsAsString()

get_fOIReleaseDetails

public String get_fOIReleaseDetails()
                             throws Exception
Throws:
Exception

getFOIReleaseDate

public Date getFOIReleaseDate()

Refinement of rights

The date of past or future release.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_fOIReleaseDate

public String get_fOIReleaseDate()
                          throws Exception
Throws:
Exception

getGroupAccess

public String[] getGroupAccess()

Refinement of rights

Name of a group or groups which have the right to access the resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


getGroupAccessAsString

public String getGroupAccessAsString()

get_groupAccess

public String get_groupAccess()
                       throws Exception
Throws:
Exception

getIndividualUserAccessList

public String[] getIndividualUserAccessList()

Refinement of rights

Names of individuals having access to the resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


getIndividualUserAccessListAsString

public String getIndividualUserAccessListAsString()

get_individualUserAccessList

public String get_individualUserAccessList()
                                    throws Exception
Throws:
Exception

getLastFOIDisclosabilityReview

public String getLastFOIDisclosabilityReview()

Refinement of rights

The date of the previous formal decision regarding the disclosability of a resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_lastFOIDisclosabilityReview

public String get_lastFOIDisclosabilityReview()
                                       throws Exception
Throws:
Exception

getPreviousProtectiveMarking

public String[] getPreviousProtectiveMarking()

Refinement of rights

Protective marking previously applied to a resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


getPreviousProtectiveMarkingAsString

public String getPreviousProtectiveMarkingAsString()

get_previousProtectiveMarking

public String get_previousProtectiveMarking()
                                     throws Exception
Throws:
Exception

getProtectiveMarking

public String getProtectiveMarking()

Refinement of rights

The minimum level of security required to have access to the resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_protectiveMarking

public String get_protectiveMarking()
                             throws Exception
Throws:
Exception

getProtectiveMarkingChangeDate

public Date getProtectiveMarkingChangeDate()

Refinement of rights

The date the previous protective marking was superseded.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_protectiveMarkingChangeDate

public String get_protectiveMarkingChangeDate()
                                       throws Exception
Throws:
Exception

getProtectiveMarkingExpiryDate

public Date getProtectiveMarkingExpiryDate()

Refinement of rights

Date on which the existing protective marking becomes invalid.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_protectiveMarkingExpiryDate

public String get_protectiveMarkingExpiryDate()
                                       throws Exception
Throws:
Exception

getStatus

public String getStatus()

The position or state of the resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


get_status

public String get_status()
                  throws Exception
Throws:
Exception

getCategory

public String[] getCategory()

Refinement of subject

Broad subject categories from the Government Category List, and, optionally, any other widely available category list.Comment: This is to allow users to scroll down through a list of very broad terms (e.g. Business and Industry) to narrower categories (e.g. Companies, Imports).

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


getCategoryAsString

public String getCategoryAsString()

get_category

public String get_category()
                    throws Exception
Throws:
Exception

getKeyword

public String[] getKeyword()

Refinement of subject

Words or terms used to describe, as specifically as possible, the subject matter of the resource. These should be taken from a controlled vocabulary or list.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


getKeywordAsString

public String getKeywordAsString()

get_keyword

public String get_keyword()
                   throws Exception
Throws:
Exception

getProcessIdentifier

public String[] getProcessIdentifier()

Refinement of subject

Indicates a specific service or transaction, using an identifier taken from a recognised list.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


getProcessIdentifierAsString

public String getProcessIdentifierAsString()

get_processIdentifier

public String get_processIdentifier()
                             throws Exception
Throws:
Exception

getProgramme

public String[] getProgramme()

Refinement of subject

The broader policy programme to which this resource relates directly.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


getProgrammeAsString

public String getProgrammeAsString()

get_programme

public String get_programme()
                     throws Exception
Throws:
Exception

getProject

public String[] getProject()

Refinement of subject

The specific project that this resource relates to directly.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


getProjectAsString

public String getProjectAsString()

get_project

public String get_project()
                   throws Exception
Throws:
Exception

getAlternativeTitle

public String[] getAlternativeTitle()

Refinement of title

Any form of the title used as a substitute or alternative to the formal title of the resource.

For more information see http://www.govtalk.gov.uk/documents/metadataV2.pdf


getAlternativeTitleAsString

public String getAlternativeTitleAsString()

get_alternativeTitle

public String get_alternativeTitle()
                            throws Exception
Throws:
Exception

getDatesModified

public String[] getDatesModified()

An array of modification dates (currently stored as Strings as Data arrays are not yet supported).


getDatesModifiedAsString

public String getDatesModifiedAsString()

get_datesModified

public String get_datesModified()
                         throws Exception
Throws:
Exception

getAccessibility

public String getAccessibility()
This property replaces:
accessability

get_accessibility

public String get_accessibility()
                         throws Exception
Throws:
Exception

getDateAquired

public Date getDateAquired()

Incorrectly spelled property.

Replaced by EGMSResource2.dateAcquired.


get_dateAquired

public String get_dateAquired()
                       throws Exception
Throws:
Exception

getDescriptor

public static FeatureDescriptor getDescriptor(String featureName)
get the descriptor for a feature of the class, either method or attribute Note: the methods' feature are still not implemented

Parameters:
featureName -

getPartsDescriptor

public static Collection getPartsDescriptor()
Returns:
the descriptor of the attribute that are part of the class

getGetterMethods

public static Collection getGetterMethods()
Returns:
the descriptor of the attribute that are part of the class

newInstance

public static Resource newInstance(RDFDB db)
                            throws Exception
Create a new object of this type with a locally unique id and returns it

Parameters:
db - the db where the object is to be found or created
Returns:
an object of this type
Throws:
Exception

listenForNewObj

public static void listenForNewObj(NewObjListener listener)
Register to be notified when new objects are added.

Parameters:
listener - the listener

initialised

public void initialised()
Notify that the object has been created and its properties setup for the first time. This is NOT called when the object is simply reloaded.

Overrides:
initialised in class DCResource

retrieve

public static Resource retrieve(URL id)
                         throws Exception
If an object of type EGMSResource with the indicated id has already being retrieved from the network returns it otherwise retrieve it together with its class information (methods, properties, etc.)

Parameters:
id - the id of the object to retrieve
Returns:
an object of type EGMSResource with the indicated id
Throws:
Exception

clear

public void clear()
Description copied from class: RDFObject
Clear all properties of this object

Overrides:
clear in class DCResource

Delete

public Bookmark Delete()
                throws Exception

Delete an isolated EGMResource. If the resource is associated to another object (Person, Event or Study) an error is returned and the resource is not deleted.

Throws:
Exception

Delete

public void Delete(BasicExecutorLog log)
            throws Exception

Delete an isolated EGMResource. If the resource is associated to another object (Person, Event or Study) an error is returned and the resource is not deleted.

Parameters:
log - the Executor of this method;if null a default one is used
Throws:
Exception

Nesstar SDK

Copyright©2003 NSD - All Rights Reserved