com.codemonster.surinam.export.meta
Annotation Type Contract


@Documented
@Retention(value=RUNTIME)
public @interface Contract

This is the primary annotation for Service Contracts; see individual fields for detail on each.

Author:
Samuel Provencher

Required Element Summary
 String author
          This would be the individual contact of record for this release.
 String description
          Since this annotation is attached to a specific class, it is also appropriate to provide some short description of what this service contract definition is all about.
 String organization
          For larger organizations who are implementation providers, they can identify themselves here, possibly including some contact information; this also serves to capture the entity of origination.
 String publicationDate
          This is the date of record for this publication.
 

Element Detail

author

public abstract String author
This would be the individual contact of record for this release. For corporate releases there might be something like (i.e. "userSupport@acme.com") and for individual implementation providers who don't have a corporate identity ("Rich Programmer a.k.a dick@richardsoftware.org").

Returns:
Returns an informative string about the author.

organization

public abstract String organization
For larger organizations who are implementation providers, they can identify themselves here, possibly including some contact information; this also serves to capture the entity of origination.

Returns:
Returns an informative identification string here.

publicationDate

public abstract String publicationDate
This is the date of record for this publication.

Returns:
Returns the string representing the official release date for this Contract.

description

public abstract String description
Since this annotation is attached to a specific class, it is also appropriate to provide some short description of what this service contract definition is all about. This would be an optional place to capture semantic or usage caveats.

Returns:
Returns a short description of the implementation.


Copyright © 2010. All Rights Reserved.