org.cyclos.services.system

Interface NetworkService

All Superinterfaces:

CRUDService<NetworkDTO,NetworkData,java.lang.Void>, Service

All Known Subinterfaces:

NetworkServiceLocal

public interface NetworkService
extends CRUDService<NetworkDTO,NetworkData,java.lang.Void>

Service used to manage networks

Author:

ameyer

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Long	createWithData(NetworkDTO network, NetworkInitialDataDTO data) Creates a new network with initial data
NetworkWithInitialDataData	getDataForNewWithData() Returns data for creating a new network with initial data
java.lang.String	getFullURL(java.lang.Long networkId) It returns the full (root URL + root path) network's URL if not empty.
NetworkInitialDataDTO	getInitialData(BasicNetworkInitialDataDTO basicData) Returns an initial data pre-populated with fields according to the given initial selections
NetworkSearchData	getSearchData() Returns data for searching networks
Page<NetworkVO>	search(NetworkQuery query) Searches for networks according to the given criteria

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Method Detail

createWithData

java.lang.Long createWithData(NetworkDTO network,
                            NetworkInitialDataDTO data)
                              throws FrameworkException

Creates a new network with initial data

Throws:

FrameworkException

getDataForNewWithData

NetworkWithInitialDataData getDataForNewWithData()
                                                 throws FrameworkException

Returns data for creating a new network with initial data

Throws:

FrameworkException

getFullURL

java.lang.String getFullURL(java.lang.Long networkId)
                            throws FrameworkException

It returns the full (root URL + root path) network's URL if not empty. Otherwise it returns the default configuration's root URL plus the network's root path (if not empty).

Returns:

the resolved network's full url always ending with a slash ('/')

Throws:

FrameworkException

getInitialData

NetworkInitialDataDTO getInitialData(BasicNetworkInitialDataDTO basicData)
                                     throws FrameworkException

Returns an initial data pre-populated with fields according to the given initial selections

Throws:

FrameworkException

getSearchData

NetworkSearchData getSearchData()
                                throws FrameworkException

Returns data for searching networks

Throws:

FrameworkException

search

Page<NetworkVO> search(NetworkQuery query)
                       throws FrameworkException

Searches for networks according to the given criteria

Throws:

FrameworkException