com.liferay.headless.admin.user.resource.v1_0

Interface OrganizationResource

@Generated(value="")
 @ProviderType
public interface OrganizationResource

To access this resource, run: curl -u your@email.com:yourpassword -D - http://localhost:8080/o/headless-admin-user/v1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	OrganizationResource.Builder
static interface	OrganizationResource.Factory
static class	OrganizationResource.FactoryHolder

Method Summary

Modifier and Type	Method and Description
static OrganizationResource.Builder	builder()
void	deleteOrganization(java.lang.String organizationId)
javax.ws.rs.core.Response	deleteOrganizationBatch(java.lang.String callbackURL, java.lang.Object object)
Organization	getOrganization(java.lang.String organizationId)
Page<Organization>	getOrganizationOrganizationsPage(java.lang.String parentOrganizationId, java.lang.Boolean flatten, java.lang.String search, Filter filter, Pagination pagination, Sort[] sorts)
Page<Organization>	getOrganizationsPage(java.lang.Boolean flatten, java.lang.String search, Filter filter, Pagination pagination, Sort[] sorts)
Organization	patchOrganization(java.lang.String organizationId, Organization organization)
Organization	postOrganization(Organization organization)
javax.ws.rs.core.Response	postOrganizationBatch(java.lang.String callbackURL, java.lang.Object object)
Organization	putOrganization(java.lang.String organizationId, Organization organization)
javax.ws.rs.core.Response	putOrganizationBatch(java.lang.String callbackURL, java.lang.Object object)
default void	setContextAcceptLanguage(AcceptLanguage contextAcceptLanguage)
void	setContextCompany(Company contextCompany)
default void	setContextHttpServletRequest(javax.servlet.http.HttpServletRequest contextHttpServletRequest)
default void	setContextHttpServletResponse(javax.servlet.http.HttpServletResponse contextHttpServletResponse)
default void	setContextUriInfo(javax.ws.rs.core.UriInfo contextUriInfo)
void	setContextUser(User contextUser)

Method Detail

builder

static OrganizationResource.Builder builder()

getOrganizationsPage

Page<Organization> getOrganizationsPage(java.lang.Boolean flatten,
                                        java.lang.String search,
                                        Filter filter,
                                        Pagination pagination,
                                        Sort[] sorts)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

postOrganization

Organization postOrganization(Organization organization)
                       throws java.lang.Exception

Throws:

java.lang.Exception

postOrganizationBatch

javax.ws.rs.core.Response postOrganizationBatch(java.lang.String callbackURL,
                                                java.lang.Object object)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

deleteOrganization

void deleteOrganization(java.lang.String organizationId)
                 throws java.lang.Exception

Throws:

java.lang.Exception

deleteOrganizationBatch

javax.ws.rs.core.Response deleteOrganizationBatch(java.lang.String callbackURL,
                                                  java.lang.Object object)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getOrganization

Organization getOrganization(java.lang.String organizationId)
                      throws java.lang.Exception

Throws:

java.lang.Exception

patchOrganization

Organization patchOrganization(java.lang.String organizationId,
                               Organization organization)
                        throws java.lang.Exception

Throws:

java.lang.Exception

putOrganization

Organization putOrganization(java.lang.String organizationId,
                             Organization organization)
                      throws java.lang.Exception

Throws:

java.lang.Exception

putOrganizationBatch

javax.ws.rs.core.Response putOrganizationBatch(java.lang.String callbackURL,
                                               java.lang.Object object)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getOrganizationOrganizationsPage

Page<Organization> getOrganizationOrganizationsPage(java.lang.String parentOrganizationId,
                                                    java.lang.Boolean flatten,
                                                    java.lang.String search,
                                                    Filter filter,
                                                    Pagination pagination,
                                                    Sort[] sorts)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

setContextAcceptLanguage

default void setContextAcceptLanguage(AcceptLanguage contextAcceptLanguage)

setContextCompany

void setContextCompany(Company contextCompany)

setContextHttpServletRequest

default void setContextHttpServletRequest(javax.servlet.http.HttpServletRequest contextHttpServletRequest)

setContextHttpServletResponse

default void setContextHttpServletResponse(javax.servlet.http.HttpServletResponse contextHttpServletResponse)

setContextUriInfo

default void setContextUriInfo(javax.ws.rs.core.UriInfo contextUriInfo)

setContextUser

void setContextUser(User contextUser)