[Andspidclient-commit] SF.net SVN: andspidclient:[104] trunk/src/main/java/au/csiro/doiclient/ AndsDoiClient.java

[<joh...@us...>]

Revision: 104
          http://andspidclient.svn.sourceforge.net/andspidclient/?rev=104&view=rev
Author:   johnpage-09
Date:     2012-03-09 02:26:54 +0000 (Fri, 09 Mar 2012)
Log Message:
-----------
DMSTECH-2891: Updated JavaDoc for one of the methods.

Modified Paths:
--------------
    trunk/src/main/java/au/csiro/doiclient/AndsDoiClient.java

Modified: trunk/src/main/java/au/csiro/doiclient/AndsDoiClient.java
===================================================================
--- trunk/src/main/java/au/csiro/doiclient/AndsDoiClient.java	2012-03-09 02:10:56 UTC (rev 103)
+++ trunk/src/main/java/au/csiro/doiclient/AndsDoiClient.java	2012-03-09 02:26:54 UTC (rev 104)
@@ -322,15 +322,17 @@
     /**
      * Responsible for Activating / Deactivating a DOI.
      * <p>
-     * DOI being updated must belong to the client requesting the update. The update service point allows clients to
-     * update their DOIs in 3 ways. Clients can update the URL only, metadata only, or both the URL and metadata
+     * Deactivates metadata associated with a DOI. A DOI\x92s metadata is active by default. Deactivating a DOI\x92s metadata
+     * prevents the metadata from being returned by the public \x91Request Metadata Associated with DOI\x92 service endpoint.
      * 
+     * Activates deactivated metadata associated with a given DOI. A DOI\x92s metadata is active by default, and can only
+     * by activated if it has previously been deactivated. Activating a DOI\x92s metadata allows the metadata to be
+     * returned by the public \x91Request Metadata Associated with DOI\x92 service endpoint.
+     * 
      * @param doi
-     *            that needs to be updated.
-     * @param url
-     *            the url pointing to the landing page of the data collection.
-     * @param updateMetdaData
-     *            true if metadata update is required, false if not.
+     *            that needs to be activated/ deactivated.
+     * @param activate
+     *            boolean flag indicating whether to activate or deactivate.
      * @return AndsDoiResponse {@link AndsDoiResponse} Response object holding the components of the response.
      * @throws IllegalStateException
      *             thrown if the parameters need to call the ANDS DOI service have not been provided.

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.