com.hcl.domino.richtext.records.CDActionRunAgent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of domino-jnx-api-r14 Show documentation

There is a newer version: 1.44.0

/*
 * ==========================================================================
 * Copyright (C) 2019-2022 HCL America, Inc. ( http://www.hcl.com/ )
 *                            All rights reserved.
 * ==========================================================================
 * Licensed under the  Apache License, Version 2.0  (the "License").  You may
 * not use this file except in compliance with the License.  You may obtain a
 * copy of the License at .
 *
 * Unless  required  by applicable  law or  agreed  to  in writing,  software
 * distributed under the License is distributed on an  "AS IS" BASIS, WITHOUT
 * WARRANTIES OR  CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the  specific language  governing permissions  and limitations
 * under the License.
 * ==========================================================================
 */
package com.hcl.domino.richtext.records;

import com.hcl.domino.misc.StructureSupport;
import com.hcl.domino.richtext.annotation.StructureDefinition;
import com.hcl.domino.richtext.annotation.StructureGetter;
import com.hcl.domino.richtext.annotation.StructureMember;
import com.hcl.domino.richtext.annotation.StructureSetter;
import com.hcl.domino.richtext.structures.WSIG;

/**
 * @author Jesse Gallagher
 * @since 1.0.24
 */
@StructureDefinition(name = "CDACTIONRUNAGENT", members = {
    @StructureMember(name = "Header", type = WSIG.class),
    @StructureMember(name = "dwFlags", type = int.class),
    @StructureMember(name = "wAgentNameLen", type = short.class, unsigned = true),
    @StructureMember(name = "wSpare", type = short.class)
})
public interface CDActionRunAgent extends RichTextRecord {
  default String getAgentName() {
    return StructureSupport.extractStringValue(this, 0, this.getAgentNameLength());
  }

  @StructureGetter("wAgentNameLen")
  int getAgentNameLength();

  @StructureGetter("Header")
  @Override
  WSIG getHeader();

  default CDActionRunAgent setAgentName(final String agentName) {
    return StructureSupport.writeStringValue(this, 0, this.getAgentNameLength(), agentName, this::setAgentNameLength);
  }

  @StructureSetter("wAgentNameLen")
  CDActionRunAgent setAgentNameLength(int len);
}