org.cyclos.services.system

Interface NetworkService

All Superinterfaces:

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

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

Service used to manage networks

Author:

ameyer

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GLOBAL_INTERNAL_NAME Internal name for the "global network" (or global mode)

Method Summary

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
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
java.lang.String	resolveNetworkUrl(NetworkVO network) Returns the URL a global admin can use to access the given network
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

Field Detail

GLOBAL_INTERNAL_NAME

static final java.lang.String GLOBAL_INTERNAL_NAME

Internal name for the "global network" (or global mode)

See Also:

Constant Field Values

Method Detail

createWithData

java.lang.Long createWithData(@NotNull
                              NetworkDTO network,
                              @NotNull
                              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

getInitialData

NetworkInitialDataDTO getInitialData(@NotNull
                                     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

resolveNetworkUrl

java.lang.String resolveNetworkUrl(@NotNull
                                   NetworkVO network)
                            throws FrameworkException

Returns the URL a global admin can use to access the given network

Throws:

FrameworkException

search

Page<NetworkVO> search(@NotNull
                       NetworkQuery query)
                throws FrameworkException

Searches for networks according to the given criteria

Throws:

FrameworkException