Changeset 672


Ignore:
Timestamp:
Apr 23, 2012, 7:55:16 PM (5 years ago)
Author:
david.vanenckevort@…
Message:
  • Added Javadoc comments.
File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/code/conceptwiki/common/common-api/src/main/java/nl/nbic/conceptwiki/common/api/QueryScope.java

    r656 r672  
    33import java.io.Serializable;
    44
     5/**
     6 * The QueryScope defines the scope of the data that an API call has to return.
     7 * @author <a href="mailto:kees.burger@nbic.nl">Kees Burger</a>
     8 * @author <a href="mailto:david.van.enckevort@nbic.nl">David van Enckevort</a>
     9 */
    510public interface QueryScope extends Serializable {
     11    /**
     12     * Builder pattern method to set the QueryScope to exclude the UUID.
     13     * @return a {@link QueryScope} instance that excludes the Uuid. 
     14     */
    615    QueryScope excludeUuid();
     16
     17    /**
     18     * Builder pattern method to set the QueryScope to include {@link Label Labels}.
     19     * @return a {@link QueryScope} instance that includes the Labels.
     20     */
    721    QueryScope includeLabels();
     22
     23    /**
     24     * Builder pattern method to set the QueryScope to include the {@link LabelType#PREFERRED} Label.
     25     * @return a {@link QueryScope} instance that includes the preferred label.
     26     */
    827    QueryScope includePrefLabel();
     28
     29    /**
     30     * Builder pattern method to set the QueryScope to include {@link Notation Notations}.
     31     * @return a {@link QueryScope} instance that includes the Notations.
     32     */
    933    QueryScope includeNotations();
     34
     35    /**
     36     * Builder pattern method to set the QueryScope to include {@link Note Notes}.
     37     * @return a {@link QueryScope} instance that includes the Notes.
     38     */
    1039    QueryScope includeNotes();
     40
     41    /**
     42     * Builder pattern method to set the QueryScope to include {@link Concept Tags}.
     43     * @return a {@link QueryScope} instance that includes the Tags.
     44     */
    1145    QueryScope includeTags();
     46
     47    /**
     48     * Builder pattern method to set the QueryScope to include {@link Url Urls}.
     49     * @return a {@link QueryScope} instance that includes the Urls.
     50     */
    1251    QueryScope includeUrls();
    1352   
     53    /**
     54     * Indicate if this QueryScope requests the UUID to be returned.
     55     * @return true if this QueryScope indicates that the UUID should be returned.
     56     */
    1457    boolean hasUuid();
     58   
     59    /**
     60     * Indicate if this QueryScope requests the Labels to be returned.
     61     * @return true if this QueryScope indicates that the Labels should be returned.
     62     */
    1563    boolean hasLabels();
     64   
     65    /**
     66     * Indicate if this QueryScope requests the Preferred Label to be returned.
     67     * @return true if this QueryScope indicates that the Preferred Label should be returned.
     68     */
    1669    boolean hasPrefLabel();
     70   
     71    /**
     72     * Indicate if this QueryScope requests the Notations to be returned.
     73     * @return true if this QueryScope indicates that the Notations should be returned.
     74     */
    1775    boolean hasNotations();
     76   
     77    /**
     78     * Indicate if this QueryScope requests the Notes to be returned.
     79     * @return true if this QueryScope indicates that the Notes should be returned.
     80     */
    1881    boolean hasNotes();
     82   
     83    /**
     84     * Indicate if this QueryScope requests the Tags to be returned.
     85     * @return true if this QueryScope indicates that the Tags should be returned.
     86     */
    1987    boolean hasTags();
     88   
     89    /**
     90     * Indicate if this QueryScope requests the Urls to be returned.
     91     * @return true if this QueryScope indicates that the Urls should be returned.
     92     */
    2093    boolean hasUrls();
    2194}
Note: See TracChangeset for help on using the changeset viewer.