won.protocol.service

Interface NeedInformationService

public interface NeedInformationService

Service for obtaining information about needs and connections in the system in RDF.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	NeedInformationService.Page<T> Deprecated.
static class	NeedInformationService.PagedResource<T,E>

Method Summary

Modifier and Type	Method and Description
org.springframework.data.domain.Slice<MessageEventPlaceholder>	listConnectionEvents(java.net.URI connectionUri, int page, java.lang.Integer preferredPageSize, WonMessageType messageType)
org.springframework.data.domain.Slice<MessageEventPlaceholder>	listConnectionEventsAfter(java.net.URI connectionUri, java.net.URI msgURI, java.lang.Integer preferredPageSize, WonMessageType msgType)
org.springframework.data.domain.Slice<MessageEventPlaceholder>	listConnectionEventsBefore(java.net.URI connectionUri, java.net.URI msgURI, java.lang.Integer preferredPageSize, WonMessageType msgType)
org.springframework.data.domain.Slice<java.net.URI>	listConnectionEventURIsAfter(java.net.URI connectionUri, java.net.URI msgURI, java.lang.Integer preferredPageSize, WonMessageType msgType) Deprecated.
org.springframework.data.domain.Slice<java.net.URI>	listConnectionEventURIsBefore(java.net.URI connectionUri, java.net.URI msgURI, java.lang.Integer preferredPageSize, WonMessageType msgType) Deprecated.
java.util.Collection<java.net.URI>	listConnectionURIs() Retrieves all connection URIs (regardless of state).
org.springframework.data.domain.Slice<java.net.URI>	listConnectionURIs(int page, java.lang.Integer preferredSize, java.util.Date timeSpot) Retrieves slice of the connection URIs list for a given page number
java.util.Collection<java.net.URI>	listConnectionURIs(java.net.URI needURI) Retrieves all connection URIs (regardless of state) for the specified local need URI.
org.springframework.data.domain.Slice<java.net.URI>	listConnectionURIs(java.net.URI needURI, int page, java.lang.Integer preferredSize, WonMessageType messageType, java.util.Date timeSpot) Retrieves slice of the list of connection URIs for the specified local need URI.
org.springframework.data.domain.Slice<java.net.URI>	listConnectionURIsAfter(java.net.URI resumeConnURI, java.lang.Integer preferredPageSize, java.util.Date timeSpot) Retrieves slice of the connection URIs that follows the given connection URI from the point of view of their latest events.
org.springframework.data.domain.Slice	listConnectionURIsAfter(java.net.URI needURI, java.net.URI resumeConnURI, java.lang.Integer preferredPageSize, WonMessageType messageType, java.util.Date timeSpot) Retrieves slice of the connection URIs that follows the given connection URI from the point of view of their latest events.
org.springframework.data.domain.Slice<java.net.URI>	listConnectionURIsBefore(java.net.URI resumeConnURI, java.lang.Integer preferredPageSize, java.util.Date timeSpot) Retrieves slice of the connection URIs that precede the given connection URI from the point of view of their latest events.
org.springframework.data.domain.Slice	listConnectionURIsBefore(java.net.URI needURI, java.net.URI resumeConnURI, java.lang.Integer preferredPageSize, WonMessageType messageType, java.util.Date timeSpot) Retrieves slice of the connection URIs for the specified local need URI that precede the given connection URI from the point of view of their latest events.
java.util.Collection<java.net.URI>	listModifiedConnectionURIsAfter(java.util.Date modifiedAfter) Retrieves all connection URIs that were modified (by adding events) after a certain date
java.util.Collection<java.net.URI>	listModifiedNeedURIsAfter(java.util.Date modifiedAfter) retrieves needs that have been modified after a certain date
java.util.Collection<java.net.URI>	listNeedURIs() Retrieves a list of all needs on the needserver.
org.springframework.data.domain.Slice<java.net.URI>	listNeedURIs(int page, java.lang.Integer preferredSize, NeedState needState) Retrieves a page of the list of needs on the needserver that have a given state with number of need uris per page preference.
org.springframework.data.domain.Slice<java.net.URI>	listNeedURIsAfter(java.net.URI need, java.lang.Integer preferredSize, NeedState needState) Retrieves list of needs on the needserver that where created later than the given need that have a given state with number of need uris per page preference.
org.springframework.data.domain.Slice<java.net.URI>	listNeedURIsBefore(java.net.URI need, java.lang.Integer preferredSize, NeedState needState) Retrieves list of needs on the needserver that where created earlier than the given need that have a given state with number of need uris per page preference.
Connection	readConnection(java.net.URI connectionURI) Read general information about the connection.
DataWithEtag<Connection>	readConnection(java.net.URI connectionURI, java.lang.String Etag) read connection data including etag if connection version number is equal to etag
org.apache.jena.rdf.model.Model	readConnectionContent(java.net.URI connectionURI) Retrieves the public description of the connection as an RDF graph.
Need	readNeed(java.net.URI needURI) Read general information about the need.
DataWithEtag<Need>	readNeed(java.net.URI needURI, java.lang.String etag) read need data including if need version number is equal to etag
org.apache.jena.rdf.model.Model	readNeedContent(java.net.URI needURI) Retrieves the public description of the need as an RDF graph.

Method Detail

listNeedURIs

java.util.Collection<java.net.URI> listNeedURIs()

Retrieves a list of all needs on the needserver.

Returns:

a collection of all need URIs.

listNeedURIs

org.springframework.data.domain.Slice<java.net.URI> listNeedURIs(int page,
                                                                 java.lang.Integer preferredSize,
                                                                 NeedState needState)

Retrieves a page of the list of needs on the needserver that have a given state with number of need uris per page preference.

Parameters:

page - the page number

preferredSize - preferred number of members per page, null => use default

needState - Active/Inactive, null => all states

Returns:

a collection of all need URIs.

listNeedURIsBefore

org.springframework.data.domain.Slice<java.net.URI> listNeedURIsBefore(java.net.URI need,
                                                                       java.lang.Integer preferredSize,
                                                                       NeedState needState)

Retrieves list of needs on the needserver that where created earlier than the given need that have a given state with number of need uris per page preference.

Parameters:

need -

preferredSize - preferred number of members per page, null => use default

needState - Active/Inactive, null => all states

Returns:

a collection of all need URIs.

listNeedURIsAfter

org.springframework.data.domain.Slice<java.net.URI> listNeedURIsAfter(java.net.URI need,
                                                                      java.lang.Integer preferredSize,
                                                                      NeedState needState)

Retrieves list of needs on the needserver that where created later than the given need that have a given state with number of need uris per page preference.

Parameters:

need -

preferredSize - preferred number of members per page, null => use default

needState - Active/Inactive, null => all states

Returns:

a collection of all need URIs.

listModifiedNeedURIsAfter

java.util.Collection<java.net.URI> listModifiedNeedURIsAfter(java.util.Date modifiedAfter)

retrieves needs that have been modified after a certain date

Parameters:

modifiedAfter - modification date of the needs to retrieve

Returns:

collection of modified needs

listConnectionURIs

java.util.Collection<java.net.URI> listConnectionURIs()

Retrieves all connection URIs (regardless of state).

Returns:

a collection of connection URIs.

listModifiedConnectionURIsAfter

java.util.Collection<java.net.URI> listModifiedConnectionURIsAfter(java.util.Date modifiedAfter)

Retrieves all connection URIs that were modified (by adding events) after a certain date

Parameters:

modifiedAfter - modification date

Returns:

listConnectionURIs

org.springframework.data.domain.Slice<java.net.URI> listConnectionURIs(int page,
                                                                       java.lang.Integer preferredSize,
                                                                       java.util.Date timeSpot)

Retrieves slice of the connection URIs list for a given page number

Parameters:

page - the page number

preferredSize - preferred number of members per page or null; null => use default

timeSpot - time at which we want the list state to be fixed, if null - current state

Returns:

a slice connection URIs.

listConnectionURIsBefore

org.springframework.data.domain.Slice<java.net.URI> listConnectionURIsBefore(java.net.URI resumeConnURI,
                                                                             java.lang.Integer preferredPageSize,
                                                                             java.util.Date timeSpot)

Retrieves slice of the connection URIs that precede the given connection URI from the point of view of their latest events.

Parameters:

resumeConnURI - the returned slice connections precede (in time of their latest events) this connection uri

preferredPageSize - preferred number of members per page or null; null => use default

timeSpot - time at which we want the list state to be fixed, cannot be null

Returns:

a slice of connection URIs.

listConnectionURIsAfter

org.springframework.data.domain.Slice<java.net.URI> listConnectionURIsAfter(java.net.URI resumeConnURI,
                                                                            java.lang.Integer preferredPageSize,
                                                                            java.util.Date timeSpot)

Retrieves slice of the connection URIs that follows the given connection URI from the point of view of their latest events.

Parameters:

resumeConnURI - the returned slice connections follow (in time of their latest events) this connection uri

preferredPageSize - preferred number of members per page or null; null => use default

timeSpot - time at which we want the list state to be fixed, cannot be null

Returns:

a slice of connection URIs.

listConnectionURIs

java.util.Collection<java.net.URI> listConnectionURIs(java.net.URI needURI)
                                               throws NoSuchNeedException

Retrieves all connection URIs (regardless of state) for the specified local need URI.

Parameters:

needURI - the URI of the need

Returns:

a collection of connection URIs.

Throws:

NoSuchNeedException - if needURI is not a known need URI

listConnectionURIs

org.springframework.data.domain.Slice<java.net.URI> listConnectionURIs(java.net.URI needURI,
                                                                       int page,
                                                                       java.lang.Integer preferredSize,
                                                                       WonMessageType messageType,
                                                                       java.util.Date timeSpot)

Retrieves slice of the list of connection URIs for the specified local need URI.

Parameters:

needURI - the URI of the need

page - the page number

preferredSize - preferred number of members per page or null; null => use default

messageType - event type that should be used for defining connection latest activity; null => all event types

timeSpot - time at which we want the list state to be fixed, if null - current state

Returns:

a collection of connection URIs.

Throws:

NoSuchNeedException - if needURI is not a known need URI

listConnectionURIsBefore

org.springframework.data.domain.Slice listConnectionURIsBefore(java.net.URI needURI,
                                                               java.net.URI resumeConnURI,
                                                               java.lang.Integer preferredPageSize,
                                                               WonMessageType messageType,
                                                               java.util.Date timeSpot)

Retrieves slice of the connection URIs for the specified local need URI that precede the given connection URI from the point of view of their latest events.

Parameters:

resumeConnURI - the returned slice connections precede (in time of their latest events) this connection uri

preferredPageSize - preferred number of members per page or null; null => use default

messageType - event type that should be used for defining connection latest activity; null => all event types

timeSpot - time at which we want the list state to be fixed, cannot be null

Returns:

a slice of connection URIs.

listConnectionURIsAfter

org.springframework.data.domain.Slice listConnectionURIsAfter(java.net.URI needURI,
                                                              java.net.URI resumeConnURI,
                                                              java.lang.Integer preferredPageSize,
                                                              WonMessageType messageType,
                                                              java.util.Date timeSpot)

Retrieves slice of the connection URIs that follows the given connection URI from the point of view of their latest events.

Parameters:

resumeConnURI - the returned slice connections follow (in time of their latest events) this connection uri

preferredPageSize - preferred number of members per page or null; null => use default

messageType - event type that should be used for defining connection latest activity; null => all event types

timeSpot - time at which we want the list state to be fixed, cannot be null

Returns:

a slice of connection URIs.

readNeed

Need readNeed(java.net.URI needURI)
       throws NoSuchNeedException

Read general information about the need.

Parameters:

needURI -

Returns:

Throws:

NoSuchNeedException

readNeed

DataWithEtag<Need> readNeed(java.net.URI needURI,
                            java.lang.String etag)
                     throws NoSuchNeedException

read need data including if need version number is equal to etag

Parameters:

needURI - describes the need to lookup

etag - describes the version of the data to look up

Returns:

need data with corresponding etag version number or null if no need with the specified URI or the version number of the etag is found

Throws:

NoSuchNeedException

readNeedContent

org.apache.jena.rdf.model.Model readNeedContent(java.net.URI needURI)
                                         throws NoSuchNeedException

Retrieves the public description of the need as an RDF graph.

Parameters:

needURI -

Returns:

Throws:

NoSuchNeedException

readConnection

Connection readConnection(java.net.URI connectionURI)
                   throws NoSuchConnectionException

Read general information about the connection.

Parameters:

connectionURI -

Returns:

Throws:

NoSuchNeedException

NoSuchConnectionException

readConnection

DataWithEtag<Connection> readConnection(java.net.URI connectionURI,
                                        java.lang.String Etag)

read connection data including etag if connection version number is equal to etag

Parameters:

connectionURI - describes the connection to lookup

Etag - describes the version of the data to look up

Returns:

connection data with corresponding etag version number or null if no need with the specified URI or the version number of the etag is found

readConnectionContent

org.apache.jena.rdf.model.Model readConnectionContent(java.net.URI connectionURI)
                                               throws NoSuchConnectionException

Retrieves the public description of the connection as an RDF graph.

Parameters:

connectionURI -

Returns:

Throws:

NoSuchNeedException

NoSuchConnectionException

listConnectionEvents

org.springframework.data.domain.Slice<MessageEventPlaceholder> listConnectionEvents(java.net.URI connectionUri,
                                                                                    int page,
                                                                                    java.lang.Integer preferredPageSize,
                                                                                    WonMessageType messageType)

listConnectionEventURIsBefore

@Deprecated
org.springframework.data.domain.Slice<java.net.URI> listConnectionEventURIsBefore(java.net.URI connectionUri,
                                                                                              java.net.URI msgURI,
                                                                                              java.lang.Integer preferredPageSize,
                                                                                              WonMessageType msgType)

Deprecated.

Retrieves list of event uris of the specified connection that where created earlier than the given event (specified by event message uri) and that have a given message type, with number of uris per page preference.

Parameters:

connectionUri -

msgURI - before which the messages should be returned (created before this message msgURI)

preferredPageSize - preferred number of members per page, null => use default

msgType - null => all types

Returns:

a collection of all event URIs.

listConnectionEventsBefore

org.springframework.data.domain.Slice<MessageEventPlaceholder> listConnectionEventsBefore(java.net.URI connectionUri,
                                                                                          java.net.URI msgURI,
                                                                                          java.lang.Integer preferredPageSize,
                                                                                          WonMessageType msgType)

listConnectionEventURIsAfter

@Deprecated
org.springframework.data.domain.Slice<java.net.URI> listConnectionEventURIsAfter(java.net.URI connectionUri,
                                                                                             java.net.URI msgURI,
                                                                                             java.lang.Integer preferredPageSize,
                                                                                             WonMessageType msgType)

Deprecated.

Retrieves list of event uris of the specified connection that where created later than the given event (specified by event message uri) and that have a given message type, with number of uris per page preference.

Parameters:

connectionUri -

msgURI - after which the messages should be returned (created after this message msgURI)

preferredPageSize - preferred number of members per page, null => use default

msgType - null => all types

Returns:

a collection of all event URIs.

listConnectionEventsAfter

org.springframework.data.domain.Slice<MessageEventPlaceholder> listConnectionEventsAfter(java.net.URI connectionUri,
                                                                                         java.net.URI msgURI,
                                                                                         java.lang.Integer preferredPageSize,
                                                                                         WonMessageType msgType)