Changeset 3914


Ignore:
Timestamp:
Nov 6, 2007, 10:51:40 AM (14 years ago)
Author:
Martin Svensson
Message:

References #809 Documentation updated

Location:
trunk
Files:
4 edited

Legend:

Unmodified
Added
Removed
  • trunk/build.xml

    r3908 r3914  
    10671067      <path refid="core.classpath" />
    10681068      <fileset dir="${lib}/servlet">
     1069        <include name="**/*.jar"/>
     1070      </fileset>
     1071      <fileset dir="${lib}/webservices">
    10691072        <include name="**/*.jar"/>
    10701073      </fileset>
  • trunk/doc/src/docbook/developerdoc/webservices.xml

    r3907 r3914  
    5454        <para>
    5555          Base offers a way for services to allow the client applications to put their own
    56           includes and restrictions on a query before it is executed.
     56          includes and restrictions on a query before it is executed. For those who intend
     57          to develop services it is recommended to have a look in javadoc for
     58          <classname>net.sf.basedb.ws.info.QueryOptions</classname>
    5759        </para>
    5860      </listitem>
     
    6466    <para>
    6567      Web services can, at the moment, be used to provide some information and data related to
    66       experiments in BASE, like information about raw bioassays or exported bioassay set. This
    67       section lists all the available services in Base and gives a short description of what each
    68       one can be used to.
     68      experiments in BASE, like information about raw bioassays or exported bioassay set to
     69      mention some. This section lists all the available services in Base and gives a short
     70      description of each one.
    6971    </para>
    7072
     
    8486                  <para>
    8587                    Creates a new session and returns it's id. Before a session can
    86                     be used you have to login with it, see below.
     88                    be used you have to login with it.
    8789                  </para>
    8890                  <important>
     
    112114                <listitem>
    113115                  <para>
    114                     Logout and stop an active session in Base.
     116                    Logout and stops an active session in Base.
    115117                  </para>
    116118                </listitem>
     
    163165                <listitem>
    164166                  <para>
    165                     Sets a project to be active. This will be the same as when a
     167                    Sets a project to be active. This is the same as when a
    166168                    project is set to be active in the web client, see
    167169                    <xref linkend="project_permission.projects.active" />
     
    176178                <listitem>
    177179                  <para>
    178                     Gets information about each project the active session has
     180                    Gets information about each project an active session has
    179181                    permission to read.
    180182                  </para>
  • trunk/src/webservices/client/java/net/sf/basedb/ws/info/QueryOptions.java

    r3908 r3914  
    3030  It is which items to include in the query
    3131  and which restriction to put on the query.
     32  <p>
     33    The includes in this class correspond
     34    directly to the includes in
     35    {@link net.sf.basedb.core.Include}.
     36    The include options will be set to TRUE if nothing
     37    else is specified.
     38  </p>
     39 
    3240    @author Martin
    3341    @version 2.5
     
    6472  /**
    6573    A restriction to set on
    66     the query. 
     74    the query.
    6775  */
    6876  private String restriction = null;
     
    7078  /**
    7179    The prefix that represent a root alias in
    72     a query.
     80    a query. This string can be used in {{@link #restriction}
     81    and will be replaced when the restriction is
     82    inserted into a HQL query.
    7383   */
    7484  private String prefix = null;
     
    198208  }
    199209  /**
    200     Sets restriction for this query option
     210    Sets restriction for these query options.
     211    <p>
     212      The string must be in right format so it can be inserted
     213      directly into a hql query. The restriction string
     214      can contain a prefix, but it has to be set separatly
     215      {@link #setRestrictionPrefix(String)}.
     216    </p>
     217    <p>
     218      Example how this property can be used together with the prefix:<br>
     219      <i>$name='item1'</i> <br>
     220      When this string is used in a query, ie that select users, it will look like this:
     221      <i>usr.name='item1'</i>.<br>
     222    </p>
     223   
    201224    @param restriction A restriction as a string to use with HQL queries.
    202225   */
  • trunk/src/webservices/server/net/sf/basedb/ws/server/RawBioAssayService.java

    r3876 r3914  
    4646/**
    4747  Web service class for
    48   {@net.sf.basedb.core.RawBioAssay}
     48  {@link net.sf.basedb.core.RawBioAssay}
    4949    @author Martin
    5050  @version 2.5
Note: See TracChangeset for help on using the changeset viewer.